A Policy file in the installation directory of an LSST product, referred to using a URN. More...

#include <UrnPolicyFile.h>

Inheritance diagram for lsst.pex::policy::UrnPolicyFile:

Public Types
typedef std::shared_ptr< Persistable >	Ptr

Public Member Functions
	UrnPolicyFile (const std::string &urn, bool strictUrn=false, bool strictLoads=true)
	Construct a new policy file reference from a URN. 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...

virtual void	load (Policy &policy)

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

template<class Archive >
void	serialize (Archive &, unsigned int const)
	Template boost::serialization function for the base class. More...

Static Public Member Functions
static std::string	productNameFromUrn (const std::string &urn, bool strictUrn=false)
	Extract the product name from a URN. More...

static std::string	filePathFromUrn (const std::string &urn, bool strictUrn=false)
	Extract the local file path from a URN. More...

static std::string	reposFromUrn (const std::string &urn, bool strictUrn=false)
	Extract the repository name from a URN, or "" if none. More...

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

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	URN_PREFIX
	The prefix that a Policy URN starts with. More...

static const std::string	URN_PREFIX_ABBREV

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
	a default set of formats More...

Protected Attributes
boost::filesystem::path	_file
	the path to the underlying policy file More...

SupportedFormats::Ptr	_formats

Detailed Description

A Policy file in the installation directory of an LSST product, referred to using a URN.

For use of URN references in PAF-formatted policy files, see Policy Authoring Format.

The syntax is urn:eupspkg:[PRODUCT_NAME][:REPOSITORY]:PATH, although "urn:eupspkg:" may optionally be abbreviated with "@". PRODUCT_NAME is the name of an LSST product (see DefaultPolicyFile for more details on LSST product installation dirs), and REPOSITORY is a subdirectory, which other references within the Policy will be relative to (see Policy for more details on repositories).

For example:

@urn:eupspkg:some_product:some/repos:local/path/to/file.paf
@@some_product:some/repos:local/path/to/file.paf
@some_product:some/repos:local/path/to/file.paf
@some_product:local/path/to/file.paf
some_product:local/path/to/file.paf

Caveat: Only supports Dictionary's "DictionaryFile" directive if the value is prefixed like a normal URN reference with "@urn:eupspkg:" or "@@".

Definition at line 68 of file UrnPolicyFile.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<Persistable> lsst::daf::base::Persistable::Ptr

inherited

Definition at line 77 of file Persistable.h.

Constructor & Destructor Documentation

◆ UrnPolicyFile()

lsst.pex::policy::UrnPolicyFile::UrnPolicyFile	(	const std::string &	urn,
		bool	strictUrn = `false`,
		bool	strictLoads = `true`
	)

inlineexplicit

Construct a new policy file reference from a URN.

Basically, the only required element is a colon, separating the product directory from the local path.

Parameters

urn	The URN of the policy file. A prefix such as "urn:eupspkg:" or "@" is optional.
strictUrn	if true, the URN must strictly begin with "@urn:eupspkg:" or "urn:eupspkg:".
strictLoads	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 84 of file UrnPolicyFile.h.

             : DefaultPolicyFile(productNameFromUrn(urn, strictUrn).c_str(), filePathFromUrn(urn, strictUrn),
                                 reposFromUrn(urn, strictUrn), strictLoads),
               _urn(urn) {}

Member Function Documentation

◆ exists()

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

inlineinherited

return true if the file exists.

Definition at line 171 of file PolicyFile.h.

171 { return boost::filesystem::exists(_file); }

◆ filePathFromUrn()

static std::string lsst.pex::policy::UrnPolicyFile::filePathFromUrn	(	const std::string &	urn,
		bool	strictUrn = `false`
	)

static

Extract the local file path from a URN.

For example,

"@urn:eupspkg:product:repos:PATH/TO/FILE.PAF"
"@@product:repos:PATH/TO/FILE.PAF"
"@product:PATH/TO/FILE.PAF"

◆ 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

IOError if 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 183 of file PolicyFile.h.

183 { return const_cast<PolicyFile*>(this)->getFormatName(); }

◆ getInstallPath()

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

virtualinherited

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::NotFoundError if the environement variable is not defined.

Definition at line 48 of file DefaultPolicyFile.cc.

                                                                       {
     return DefaultPolicyFile::installPathFor(productName);
 }

◆ getPath()

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

inlineinherited

return the file path as a string

Definition at line 166 of file PolicyFile.h.

166 { return _file.string(); }

◆ getRepositoryPath()

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

inlineinherited

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

Definition at line 104 of file DefaultPolicyFile.h.

104 { return _repos; }

◆ installPathFor()

fs::path lsst.pex::policy::DefaultPolicyFile::installPathFor ( const char *const productName )

staticinherited

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 61 of file DefaultPolicyFile.cc.

                                                                       {
     std::string productName_DIR(productName);
  
     // transform to upper case
     std::transform(productName_DIR.begin(), productName_DIR.end(), productName_DIR.begin(),
                    std::ptr_fun<int, int>(std::toupper));
  
     // append _DIR
     productName_DIR += "_DIR";
  
     // get installation directory from environment
     const char* ipath = getenv(productName_DIR.c_str());
     if (ipath == 0)
         throw LSST_EXCEPT(pexExcept::NotFoundError, productName_DIR + ": environment variable not set");
  
     return fs::path(ipath);
 }

◆ load() [1/2]

virtual void lsst.pex::policy::PolicyFile::load ( Policy & policy )

inlinevirtualinherited

Implements lsst.pex::policy::PolicySource.

Definition at line 194 of file PolicyFile.h.

                                       {
         ((const PolicyFile*)this)->load(policy);  // delegate to const version
     }

◆ load() [2/2]

void lsst.pex::policy::DefaultPolicyFile::load ( Policy & policy ) const

virtualinherited

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

policy the policy object to load the data into

Exceptions

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 88 of file DefaultPolicyFile.cc.

                                                  {
     PolicyFile::load(policy);
     policy.loadPolicyFiles(_repos, _strict);
 }

◆ looksLikeUrn()

static bool lsst.pex::policy::UrnPolicyFile::looksLikeUrn	(	const std::string &	s,
		bool	strict = `false`
	)

static

Does s look like a URN? That is, does it start with URN_PREFIX or URN_PREFIX_ABBREV?

Parameters

s	the string to be tested
strict	if false, "@" will be accepted as a substitute for "urn:eupspkg:"; if true, urn:eupspkg must be present.

◆ productNameFromUrn()

static std::string lsst.pex::policy::UrnPolicyFile::productNameFromUrn	(	const std::string &	urn,
		bool	strictUrn = `false`
	)

static

Extract the product name from a URN.

For example,

@urn:eupspkg:PRODUCT:repos:path/to/file.paf
@@PRODUCT:repos:path/to/file.paf
@PRODUCT:path/to/file.paf

◆ reposFromUrn()

static std::string lsst.pex::policy::UrnPolicyFile::reposFromUrn	(	const std::string &	urn,
		bool	strictUrn = `false`
	)

static

Extract the repository name from a URN, or "" if none.

For example,

"@urn:eupspkg:product:REPOS:path/to/file.paf"
"@@product:REPOS:path/to/file.paf"
"@product:path/to/file.paf" – no repository, returns ""

◆ serialize()

template<class Archive >

void lsst::daf::base::Persistable::serialize	(	Archive &	,
		unsigned int const
	)

inlineinherited

Template boost::serialization function for the base class.

Doesn't actually do anything, since there is no data associated with the base. Inline to allow expansion wherever needed.

Definition at line 87 of file Persistable.h.

87 {}

Member Data Documentation

◆ _file

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

protectedinherited

the path to the underlying policy file

Definition at line 214 of file PolicyFile.h.

◆ _formats

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

protectedinherited

Definition at line 135 of file PolicySource.h.

◆ COMMENT

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

staticinherited

reg-exp for an empty line

Definition at line 203 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 208 of file PolicyFile.h.

◆ defaultFormats

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

staticinherited

a default set of formats

Definition at line 130 of file PolicySource.h.

◆ EXT_PAF

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

staticinherited

Definition at line 199 of file PolicyFile.h.

◆ EXT_XML

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

staticinherited

the PAF file extension, ".paf"

Definition at line 200 of file PolicyFile.h.

◆ SPACE_RE

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

staticinherited

the XML file extension, ".xml"

Definition at line 202 of file PolicyFile.h.

◆ URN_PREFIX

const std::string lsst.pex::policy::UrnPolicyFile::URN_PREFIX

static

The prefix that a Policy URN starts with.

May be abbreviated as "@".

Definition at line 118 of file UrnPolicyFile.h.

◆ URN_PREFIX_ABBREV

const std::string lsst.pex::policy::UrnPolicyFile::URN_PREFIX_ABBREV

static

Definition at line 119 of file UrnPolicyFile.h.

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

/j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/pex_policy/20.0.0-1-gb058bd0+46a6078777/include/lsst/pex/policy/UrnPolicyFile.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ UrnPolicyFile()

Member Function Documentation

◆ exists()

◆ filePathFromUrn()

◆ getFormatName() [1/2]

◆ getFormatName() [2/2]

◆ getInstallPath()

◆ getPath()

◆ getRepositoryPath()

◆ installPathFor()

◆ load() [1/2]

◆ load() [2/2]

◆ looksLikeUrn()

◆ productNameFromUrn()

◆ reposFromUrn()

◆ serialize()

Member Data Documentation

◆ _file

◆ _formats

◆ COMMENT

◆ CONTENTID

◆ defaultFormats

◆ EXT_PAF

◆ EXT_XML

◆ SPACE_RE

◆ URN_PREFIX

◆ URN_PREFIX_ABBREV