lsst.pex.policy
14.0
|
a representation of a default Policy file that is stored as a file in the installation directory of an LSST product. More...
#include <DefaultPolicyFile.h>
Public Member Functions | |
DefaultPolicyFile (const char *const productName, const std::string &filepath, const std::string &repos="", bool strict=true) | |
define a default policy file More... | |
virtual boost::filesystem::path | getInstallPath (const char *const productName) |
return the file path to the installation directory of a given named product. More... | |
const boost::filesystem::path & | getRepositoryPath () const |
return the full file path to the repository directory where this file will found. More... | |
virtual void | load (Policy &policy) const |
load the data from this Policy source into a Policy object. More... | |
![]() | |
PolicyFile (const SupportedFormats::Ptr &fmts=defaultFormats) | |
create a "null" Policy file that points to an unspecified file. More... | |
const std::string | getPath () const |
return the file path as a string More... | |
bool | exists () const |
return true if the file exists. More... | |
virtual const std::string & | getFormatName () |
return the name of the format that the data is stored in. More... | |
const std::string & | getFormatName () const |
PolicyFile (const std::string &filepath, const SupportedFormats::Ptr &fmts=defaultFormats) | |
create a Policy file that points a file with given path. More... | |
PolicyFile (const char *filepath, const SupportedFormats::Ptr &fmts=defaultFormats) | |
create a Policy file that points a file with given path. More... | |
PolicyFile (const boost::filesystem::path &filepath, const SupportedFormats::Ptr &fmts=defaultFormats) | |
create a Policy file that points a file with given path. More... | |
PolicyFile (const std::string &filepath, const PolicyParserFactory::Ptr &parserFactory) | |
create a Policy file that points a file with given path. More... | |
PolicyFile (const boost::filesystem::path &filepath, const PolicyParserFactory::Ptr &parserFactory) | |
create a Policy file that points a file with given path. More... | |
PolicyFile (const std::string &filepath, const boost::filesystem::path &reposDir, const SupportedFormats::Ptr &fmts=defaultFormats) | |
create a Policy file that points a file with given path in a policy file repository. More... | |
PolicyFile (const boost::filesystem::path &filepath, const boost::filesystem::path &reposDir, const SupportedFormats::Ptr &fmts=defaultFormats) | |
create a Policy file that points a file with given path in a policy file repository. More... | |
PolicyFile (const std::string &filepath, const boost::filesystem::path &reposDir, const PolicyParserFactory::Ptr &parserFactory) | |
create a Policy file that points a file with given path in a policy file repository. More... | |
PolicyFile (const boost::filesystem::path &filepath, const boost::filesystem::path &reposDir, const PolicyParserFactory::Ptr &parserFactory) | |
create a Policy file that points a file with given path in a policy file repository. More... | |
virtual void | load (Policy &policy) |
load the data from this Policy source into a Policy object More... | |
![]() | |
PolicySource (SupportedFormats::Ptr fmts=defaultFormats) | |
create a Policy file that points a file with given path. More... | |
virtual | ~PolicySource () |
destroy the source More... | |
Static Public Member Functions | |
static boost::filesystem::path | installPathFor (const char *const productName) |
return the file path to the installation directory of a given named product. More... | |
Additional Inherited Members | |
![]() | |
static const std::string | EXT_PAF |
static const std::string | EXT_XML |
the PAF file extension, ".paf" More... | |
static const boost::regex | SPACE_RE |
the XML file extension, ".xml" More... | |
static const boost::regex | COMMENT |
reg-exp for an empty line More... | |
static const boost::regex | CONTENTID |
reg-exp for the start of a comment More... | |
![]() | |
static SupportedFormats::Ptr | defaultFormats |
returns true if the given string containing a content identifier indicates that it contains dictionary data. More... | |
![]() | |
boost::filesystem::path | _file |
the path to the underlying policy file More... | |
![]() | |
SupportedFormats::Ptr | _formats |
a representation of a default Policy file that is stored as a file in the installation directory of an LSST product.
An instance is constructed from a product name, a relative path to a subdirectory representing a policy repository within the installed package, and a relative file path. To construct the full path to the file, the constructor looks for an environment variable of the form, PRODUCTNAME_DIR (where PRODUCTNAME is the given package name converted to all upper case) which names the directory where the product is installed. The full path, then, is the product installation directory concatonated with the repository directory, followed by the file path.
The policy file can reference other files; these will be automatically opened and loaded when load() is called. The paths stored in the policy files must be relative to the repository subdirectory within the product installation directory.
This class is the recommended PolicySource type to return in the PolicyConfigured interface's getDefaultPolicySource().
This class can be subclassed to provide a different implementation of determining the installation directory by overriding getInstallPath().
Definition at line 69 of file DefaultPolicyFile.h.
lsst::pex::policy::DefaultPolicyFile::DefaultPolicyFile | ( | const char *const | productName, |
const std::string & | filepath, | ||
const std::string & | repos = "" , |
||
bool | strict = true |
||
) |
define a default policy file
productName | the name of the product that the default policy is installed as part of |
filepath | the relative pathname to the policy file. |
repos | the subdirectory with the product's install directory where policy files are stored. If an empty string (default), the filepath argument is relative to the installation directory. |
strict | if true (default), load() will throw an exception if it encounters recoverable parsing errors in the underlying file (or any of the files it references). Otherwise, the loaded Policy will be incomplete. This is identical to the strict argument to Policy's loadPolicyFiles(). |
Definition at line 40 of file DefaultPolicyFile.cc.
|
virtual |
return the file path to the installation directory of a given named product.
This implementation uses the implementation provided by DefaultPolicyFile::installPathFor().
lsst::pex::exception::NotFoundError | if the environement variable is not defined. |
Definition at line 51 of file DefaultPolicyFile.cc.
|
inline |
return the full file path to the repository directory where this file will found.
Definition at line 107 of file DefaultPolicyFile.h.
|
static |
return the file path to the installation directory of a given named product.
In this implementation, the installation directory will be taken from the value of an environment variable PRODUCTNAME_DIR where PRODUCTNAME is the given name of the product with all letters converted to upper case.
Definition at line 64 of file DefaultPolicyFile.cc.
|
virtual |
load the data from this Policy source into a Policy object.
This implementation will automatically de-reference any file include directives in the policy file.
policy | the policy object to load the data into |
ParserException | if an error occurs while parsing the data |
IOError | if an I/O error occurs while reading from the source stream. |
Reimplemented from lsst::pex::policy::PolicyFile.
Definition at line 93 of file DefaultPolicyFile.cc.