lsst.pex.policy
16.0-3-g404ea43+13
|
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 Types | |
typedef unsigned long | memId |
typedef memId(* | memNewCallback) (const memId cid) |
typedef memId(* | memCallback) (const Citizen *ptr) |
typedef std::shared_ptr< Persistable > | Ptr |
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 |
std::string | repr () const |
void | markPersistent (void) |
memId | getId () const |
void | serialize (Archive &, unsigned int 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 bool | hasBeenCorrupted () |
static memId | getNextMemId () |
static int | init () |
static int | census (int, memId startingMemId=0) |
static void | census (std::ostream &stream, memId startingMemId=0) |
static const std::vector< const Citizen *> * | census () |
static int | census (int, memId startingMemId=0) |
static void | census (std::ostream &stream, memId startingMemId=0) |
static const std::vector< const Citizen *> * | census () |
static memId | setNewCallbackId (memId id) |
static memId | setNewCallbackId (memId id) |
static memId | setDeleteCallbackId (memId id) |
static memId | setDeleteCallbackId (memId id) |
static memNewCallback | setNewCallback (memNewCallback func) |
static memCallback | setDeleteCallback (memCallback func) |
static memCallback | setCorruptionCallback (memCallback func) |
Public Attributes | |
magicSentinel | |
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 |
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.
|
inlineinherited |
return true if the file exists.
Definition at line 181 of file PolicyFile.h.
|
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.
IOError | if an error occurs while reading the first few characters of the source stream. |
Implements lsst::pex::policy::PolicySource.
|
inlineinherited |
Definition at line 193 of file PolicyFile.h.
|
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.
|
inlineinherited |
return the file path as a string
Definition at line 176 of file PolicyFile.h.
|
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.
|
inlinevirtualinherited |
load the data from this Policy source into a Policy object
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. |
Implements lsst::pex::policy::PolicySource.
Definition at line 206 of file PolicyFile.h.
|
protectedinherited |
the path to the underlying policy file
Definition at line 226 of file PolicyFile.h.
|
protectedinherited |
Definition at line 142 of file PolicySource.h.
|
staticinherited |
reg-exp for an empty line
Definition at line 215 of file PolicyFile.h.
|
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.
|
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.
|
staticinherited |
Definition at line 211 of file PolicyFile.h.
|
staticinherited |
the PAF file extension, ".paf"
Definition at line 212 of file PolicyFile.h.
|
staticinherited |
the XML file extension, ".xml"
Definition at line 214 of file PolicyFile.h.