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:

Public Types
enum	{ magicSentinel = 0xdeadbeef }

typedef unsigned long	memId
	Type of the block's ID. More...

typedef memId(*	memNewCallback) (const memId cid)
	A function used to register a callback. More...

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
	Return a string representation of a Citizen. More...

void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...

memId	getId () const
	Return the Citizen's ID. More...

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


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 ()
	Check all allocated blocks for corruption. More...

static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...

static int	init ()
	Called once when the memory system is being initialised. More...

Census
Provide a list of current Citizens
static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...

static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...

static const std::vector< const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...

callbackIDs
Set callback Ids. The old Id is returned
static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...

static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...

callbacks
Set the New/Delete callback functions; in each case the previously installed callback is returned. These callback functions return a value which is Added to the previously registered id. The default callback functions are called default{New,Delete}Callback; you may want to set a break point in these callbacks from your favourite debugger
static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...

static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...

static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. 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.

Member Typedef Documentation

◆ memCallback

typedef memId(* lsst::daf::base::Citizen::memCallback) (const Citizen *ptr)

inherited

Definition at line 61 of file Citizen.h.

◆ memId

typedef unsigned long lsst::daf::base::Citizen::memId

inherited

Type of the block's ID.

Definition at line 58 of file Citizen.h.

◆ memNewCallback

typedef memId(* lsst::daf::base::Citizen::memNewCallback) (const memId cid)

inherited

A function used to register a callback.

Definition at line 60 of file Citizen.h.

◆ Ptr

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

inherited

Definition at line 77 of file Persistable.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

Enumerator
magicSentinel

Definition at line 88 of file Citizen.h.

88 { magicSentinel = 0xdeadbeef };

lsst::daf::base::Citizen::magicSentinel

Definition: Citizen.h:88

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

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.

     : PolicyFile(), _repos(), _strict(strict)
 {
     _repos = getInstallPath(productName);
     if (repos.length() > 0) _repos /= repos;
     _file = _repos / filepath;
 }

Member Function Documentation

◆ census() [1/3]

int lsst::daf::base::Citizen::census	(	int	,
		memId	startingMemId = `0`
	)

staticinherited

How many active Citizens are there?

Parameters

startingMemId Don't print Citizens with lower IDs

Definition at line 238 of file Citizen.cc.

   {
     if (startingMemId == 0) {  // easy
         ReadGuard guard(citizenLock);
         return _activeCitizens.size();
     }
 
     int n = 0;
     ReadGuard guard(citizenLock);
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         if (cur->first->_CitizenId >= startingMemId) {
             n++;
         }
     }
 
     return n;
 }

◆ census() [2/3]

void lsst::daf::base::Citizen::census	(	std::ostream &	stream,
		memId	startingMemId = `0`
	)

staticinherited

Print a list of all active Citizens to stream, sorted by ID.

Parameters

stream	stream to print to
startingMemId	Don't print Citizens with lower IDs

Definition at line 259 of file Citizen.cc.

   {
     ReadGuard guard(citizenLock);
 
     std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census());
 
     for (std::vector<Citizen const*>::const_iterator citizen = leaks->begin(), end = leaks->end();
          citizen != end; ++citizen) {
         if ((*citizen)->getId() >= startingMemId) {
             stream << (*citizen)->repr() << "\n";
         }
     }
 }

◆ census() [3/3]

std::vector< dafBase::Citizen const * > const * lsst::daf::base::Citizen::census ( )

staticinherited

Return a (newly allocated) std::vector of active Citizens sorted by ID.

You are responsible for deleting it; or you can say std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census()); and not bother (that becomes std::unique_ptr in C++11)

Definition at line 287 of file Citizen.cc.

                                                                {
     std::vector<Citizen const*>* vec = new std::vector<Citizen const*>(0);
     ReadGuard guard(citizenLock);
     vec->reserve(_activeCitizens.size());
 
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         vec->push_back(dynamic_cast<Citizen const*>(cur->first));
     }
 
     std::sort(vec->begin(), vec->end(), cmpId);
 
     return vec;
 }

◆ exists()

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

inlineinherited

return true if the file exists.

Definition at line 181 of file PolicyFile.h.

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

lsst.pex::policy::PolicyFile::_file

boost::filesystem::path _file

the path to the underlying policy file

Definition: PolicyFile.h:226

◆ 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 193 of file PolicyFile.h.

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

◆ getId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getId ( ) const

inherited

Return the Citizen's ID.

Definition at line 206 of file Citizen.cc.

206 { return _CitizenId; }

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

Definition at line 51 of file DefaultPolicyFile.cc.

                                                                       {
     return DefaultPolicyFile::installPathFor(productName);
 }

◆ getNextMemId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getNextMemId ( )

staticinherited

Return the memId of the next object to be allocated.

Definition at line 209 of file Citizen.cc.

209 { return _nextMemId(); }

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

176 { return _file.string(); }

lsst.pex::policy::PolicyFile::_file

boost::filesystem::path _file

the path to the underlying policy file

Definition: PolicyFile.h:226

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

107 { return _repos; }

◆ hasBeenCorrupted()

bool lsst::daf::base::Citizen::hasBeenCorrupted ( )

staticinherited

Check all allocated blocks for corruption.

Definition at line 316 of file Citizen.cc.

                                       {
     ReadGuard guard(citizenLock);
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         if (cur->first->_hasBeenCorrupted()) {
             return true;
         }
     }
     for (table::iterator cur = _persistentCitizens.begin(); cur != _persistentCitizens.end(); cur++) {
         if (cur->first->_hasBeenCorrupted()) {
             return true;
         }
     }
 
     return false;
 }

◆ init()

int lsst::daf::base::Citizen::init ( )

staticinherited

Called once when the memory system is being initialised.

Definition at line 196 of file Citizen.cc.

                          {
     volatile int dummy = 1;
     return dummy;
 }

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

                                                                       {
     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]

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

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

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

◆ 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

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.

Implements lsst.pex::policy::PolicySource.

Definition at line 206 of file PolicyFile.h.

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

◆ markPersistent()

void lsst::daf::base::Citizen::markPersistent ( void )

inherited

Mark a Citizen as persistent and not destroyed until process end.

Definition at line 225 of file Citizen.cc.

                                         {
     WriteGuard guard(citizenLock);
     _persistentCitizens[this] = _activeCitizens[this];
     _activeCitizens.erase(this);
 }

◆ repr()

std::string lsst::daf::base::Citizen::repr ( ) const

inherited

Return a string representation of a Citizen.

Definition at line 219 of file Citizen.cc.

                                      {
     return boost::str(boost::format("%d: %08x %s") % _CitizenId % this %
                       lsst::utils::demangleType(_typeName));
 }

◆ 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 {}

◆ setCorruptionCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setCorruptionCallback ( Citizen::memCallback func )

staticinherited

Set the CorruptionCallback function.

Parameters

func	function be called when block is found to be corrupted

Definition at line 391 of file Citizen.cc.

   {
     Citizen::memCallback old = _corruptionCallback;
     _corruptionCallback = func;
 
     return old;
 }

◆ setDeleteCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setDeleteCallback ( Citizen::memCallback func )

staticinherited

Set the DeleteCallback function.

Parameters

func	function be called when desired block is deleted

Definition at line 381 of file Citizen.cc.

   {
     Citizen::memCallback old = _deleteCallback;
     _deleteCallback = func;
 
     return old;
 }

◆ setDeleteCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setDeleteCallbackId ( Citizen::memId id )

staticinherited

Call the current DeleteCallback when block is deleted.

Parameters

id	Desired ID

Definition at line 347 of file Citizen.cc.

   {
     WriteGuard guard(citizenLock);
     Citizen::memId oldId = _deleteId;
     _deleteId = id;
 
     return oldId;
 }

◆ setNewCallback()

dafBase::Citizen::memNewCallback lsst::daf::base::Citizen::setNewCallback ( Citizen::memNewCallback func )

staticinherited

Set the NewCallback function.

Parameters

func	The new function to be called when a designated block is allocated

Definition at line 371 of file Citizen.cc.

   {
     Citizen::memNewCallback old = _newCallback;
     _newCallback = func;
 
     return old;
 }

◆ setNewCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setNewCallbackId ( Citizen::memId id )

staticinherited

Call the NewCallback when block is allocated.

Parameters

id	Desired ID

Definition at line 337 of file Citizen.cc.

   {
     WriteGuard guard(citizenLock);
     Citizen::memId oldId = _newId;
     _newId = id;
 
     return oldId;
 }

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:

/j/snowflake/release/lsstsw/stack/Linux64/pex_policy/18.1.0/include/lsst/pex/policy/DefaultPolicyFile.h
/j/snowflake/release/lsstsw/stack/Linux64/pex_policy/18.1.0/src/DefaultPolicyFile.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ memCallback

◆ memId

◆ memNewCallback

◆ Ptr

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ DefaultPolicyFile()

Member Function Documentation

◆ census() [1/3]

◆ census() [2/3]

◆ census() [3/3]

◆ exists()

◆ getFormatName() [1/2]

◆ getFormatName() [2/2]

◆ getId()

◆ getInstallPath()

◆ getNextMemId()

◆ getPath()

◆ getRepositoryPath()

◆ hasBeenCorrupted()

◆ init()

◆ installPathFor()

◆ load() [1/2]

◆ load() [2/2]

◆ markPersistent()

◆ repr()

◆ serialize()

◆ setCorruptionCallback()

◆ setDeleteCallback()

◆ setDeleteCallbackId()

◆ setNewCallback()

◆ setNewCallbackId()

Member Data Documentation

◆ _file

◆ _formats

◆ COMMENT

◆ CONTENTID

◆ defaultFormats

◆ EXT_PAF

◆ EXT_XML

◆ SPACE_RE