LSSTApplications  20.0.0
LSSTDataManagementBasePackage
UrnPolicyFile.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008, 2009, 2010 LSST Corporation.
6  *
7  * This product includes software developed by the
8  * LSST Project (http://www.lsst.org/).
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the LSST License Statement and
21  * the GNU General Public License along with this program. If not,
22  * see <http://www.lsstcorp.org/LegalNotices/>.
23  */
24 
35 #ifndef LSST_PEX_POLICY_URNPOLICYFILE_H
36 #define LSST_PEX_POLICY_URNPOLICYFILE_H
37 
39 
40 namespace lsst {
41 namespace pex {
42 namespace policy {
43 
69 public:
84  explicit UrnPolicyFile(const std::string& urn, bool strictUrn = false, bool strictLoads = true)
85  // TODO: oops, this is a segfault waiting to happen -- pass a string instead?
86  : DefaultPolicyFile(productNameFromUrn(urn, strictUrn).c_str(), filePathFromUrn(urn, strictUrn),
87  reposFromUrn(urn, strictUrn), strictLoads),
88  _urn(urn) {}
89 
96  static std::string productNameFromUrn(const std::string& urn, bool strictUrn = false);
97 
104  static std::string filePathFromUrn(const std::string& urn, bool strictUrn = false);
105 
112  static std::string reposFromUrn(const std::string& urn, bool strictUrn = false);
113 
115 
118  static const std::string URN_PREFIX; // "urn:eupspkg:";
119  static const std::string URN_PREFIX_ABBREV; // "@";
121 
129  static bool looksLikeUrn(const std::string& s, bool strict = false);
130 
131 private:
132  const std::string _urn;
133 };
134 
135 } // namespace policy
136 } // namespace pex
137 } // namespace lsst
138 
139 #endif // LSST_PEX_POLICY_URNPOLICYFILE_H
lsst::pex::policy::UrnPolicyFile
A Policy file in the installation directory of an LSST product, referred to using a URN.
Definition: UrnPolicyFile.h:68
std::string
STL class.
lsst::pex::policy::UrnPolicyFile::UrnPolicyFile
UrnPolicyFile(const std::string &urn, bool strictUrn=false, bool strictLoads=true)
Construct a new policy file reference from a URN.
Definition: UrnPolicyFile.h:84
lsst::pex::policy::DefaultPolicyFile
a representation of a default Policy file that is stored as a file in the installation directory of a...
Definition: DefaultPolicyFile.h:69
lsst::pex::policy::UrnPolicyFile::looksLikeUrn
static bool looksLikeUrn(const std::string &s, bool strict=false)
Does s look like a URN? That is, does it start with URN_PREFIX or URN_PREFIX_ABBREV?
DefaultPolicyFile.h
the definition of the DefaultPolicyFile class
pex
Definition: __init__.py:1
lsst::pex::policy::UrnPolicyFile::filePathFromUrn
static std::string filePathFromUrn(const std::string &urn, bool strictUrn=false)
Extract the local file path from a URN.
lsst::pex::policy::UrnPolicyFile::reposFromUrn
static std::string reposFromUrn(const std::string &urn, bool strictUrn=false)
Extract the repository name from a URN, or "" if none.
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::pex::policy::UrnPolicyFile::URN_PREFIX
static const std::string URN_PREFIX
The prefix that a Policy URN starts with.
Definition: UrnPolicyFile.h:118
lsst::pex::policy::UrnPolicyFile::URN_PREFIX_ABBREV
static const std::string URN_PREFIX_ABBREV
Definition: UrnPolicyFile.h:119
lsst::pex::policy::UrnPolicyFile::productNameFromUrn
static std::string productNameFromUrn(const std::string &urn, bool strictUrn=false)
Extract the product name from a URN.