lsst.pex.policy  13.0-2-g4b114ac+9
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
lsst::pex::policy::DefaultPolicyFile Class Reference

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>

Inheritance diagram for lsst::pex::policy::DefaultPolicyFile:
lsst::pex::policy::PolicyFile lsst::pex::policy::PolicySource lsst::pex::policy::UrnPolicyFile

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...
 
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
 
virtual void load (Policy &policy)
 load the data from this Policy source into a Policy object 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...
 

Static Public Attributes

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...
 

Protected Attributes

boost::filesystem::path _file
 the path to the underlying policy file More...
 
SupportedFormats::Ptr _formats
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ DefaultPolicyFile()

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

Parameters
productNamethe name of the product that the default policy is installed as part of
filepaththe relative pathname to the policy file.
reposthe 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.
strictif 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.

Member Function Documentation

◆ exists()

bool lsst::pex::policy::PolicyFile::exists ( ) const
inlineinherited

return true if the file exists.

Definition at line 181 of file PolicyFile.h.

◆ getFormatName() [1/2]

virtual const std::string& lsst::pex::policy::PolicyFile::getFormatName ( )
virtualinherited

return the name of the format that the data is stored in.

This may cause the first few records of the source to be read. In this implementation, once the format is definitely determined, the format name is cached internally, preventing re-determination on the next call to this function.

Exceptions
IOErrorif an error occurs while reading the first few characters of the source stream.

Implements lsst::pex::policy::PolicySource.

◆ getFormatName() [2/2]

const std::string& lsst::pex::policy::PolicyFile::getFormatName ( ) const
inlineinherited

Definition at line 193 of file PolicyFile.h.

◆ getInstallPath()

fs::path lsst::pex::policy::DefaultPolicyFile::getInstallPath ( const char *const  productName)
virtual

return the file path to the installation directory of a given named product.

This implementation uses the implementation provided by DefaultPolicyFile::installPathFor().

Exceptions
lsst::pex::exception::NotFoundErrorif the environement variable is not defined.

Definition at line 51 of file DefaultPolicyFile.cc.

◆ getPath()

const std::string lsst::pex::policy::PolicyFile::getPath ( ) const
inlineinherited

return the file path as a string

Definition at line 176 of file PolicyFile.h.

◆ getRepositoryPath()

const boost::filesystem::path& lsst::pex::policy::DefaultPolicyFile::getRepositoryPath ( ) const
inline

return the full file path to the repository directory where this file will found.

Definition at line 107 of file DefaultPolicyFile.h.

◆ installPathFor()

fs::path lsst::pex::policy::DefaultPolicyFile::installPathFor ( const char *const  productName)
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.

◆ load() [1/2]

void lsst::pex::policy::DefaultPolicyFile::load ( Policy policy) const
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.

Parameters
policythe policy object to load the data into
Exceptions
ParserExceptionif an error occurs while parsing the data
IOErrorif 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.

◆ load() [2/2]

virtual void lsst::pex::policy::PolicyFile::load ( Policy policy)
inlinevirtualinherited

load the data from this Policy source into a Policy object

Parameters
policythe policy object to load the data into
Exceptions
ParserExceptionif an error occurs while parsing the data
IOErrorif an I/O error occurs while reading from the source stream.

Implements lsst::pex::policy::PolicySource.

Definition at line 206 of file PolicyFile.h.

Member Data Documentation

◆ _file

boost::filesystem::path lsst::pex::policy::PolicyFile::_file
protectedinherited

the path to the underlying policy file

Definition at line 226 of file PolicyFile.h.

◆ _formats

SupportedFormats::Ptr lsst::pex::policy::PolicySource::_formats
protectedinherited

Definition at line 142 of file PolicySource.h.

◆ COMMENT

const boost::regex lsst::pex::policy::PolicyFile::COMMENT
staticinherited

reg-exp for an empty line

Definition at line 215 of file PolicyFile.h.

◆ CONTENTID

const boost::regex lsst::pex::policy::PolicyFile::CONTENTID
staticinherited

reg-exp for the start of a comment

reg-exp for a Policy content identifier, "<?cfg [format] [content] ?>"

Definition at line 220 of file PolicyFile.h.

◆ defaultFormats

SupportedFormats::Ptr lsst::pex::policy::PolicySource::defaultFormats
staticinherited

returns true if the given string containing a content identifier indicates that it contains dictionary data.

Dictionary data has a content id of "<?cfg ... dictionary ?>" (where ... indicates the format); policy data has an id of "<?cfg ... policy ?>". a default set of formats

Definition at line 135 of file PolicySource.h.

◆ EXT_PAF

const std::string lsst::pex::policy::PolicyFile::EXT_PAF
staticinherited

Definition at line 211 of file PolicyFile.h.

◆ EXT_XML

const std::string lsst::pex::policy::PolicyFile::EXT_XML
staticinherited

the PAF file extension, ".paf"

Definition at line 212 of file PolicyFile.h.

◆ SPACE_RE

const boost::regex lsst::pex::policy::PolicyFile::SPACE_RE
staticinherited

the XML file extension, ".xml"

Definition at line 214 of file PolicyFile.h.


The documentation for this class was generated from the following files: