a representation of a string containing Policy parameter data More...

#include <PolicyString.h>

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

Public Types
typedef std::shared_ptr< Persistable >	Ptr

Public Member Functions
	PolicyString (const std::string &data, const SupportedFormats::Ptr &fmts=defaultFormats)
	create a PolicyString that's wrapped around a given string. More...

	PolicyString (const SupportedFormats::Ptr &fmts=defaultFormats)
	create a "null" Policy formed from an empty string. More...

const std::string &	getData () const
	return the wrapped policy data as a string 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...

void	load (Policy &policy) const
	load the data from this Policy source into a Policy object More...

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

Static Public Attributes
static const boost::regex	SPACE_RE

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
std::string	_data
	the policy data More...

SupportedFormats::Ptr	_formats

Detailed Description

a representation of a string containing Policy parameter data

This class facilitates reading data from a string. This class is especially useful for supporting string I/O from Python. The data is encoded in a supported format (just like the contents of a policy file).

Definition at line 52 of file PolicyString.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

◆ PolicyString() [1/2]

lsst.pex::policy::PolicyString::PolicyString	(	const std::string &	data,
		const SupportedFormats::Ptr &	fmts = `defaultFormats`
	)

explicit

create a PolicyString that's wrapped around a given string.

Parameters

data	the path to the file, either as a string or a boost::filesystem::path instance
fmts	a SupportedFormats object to use. An instance encapsulates a configured set of known formats.

◆ PolicyString() [2/2]

lsst.pex::policy::PolicyString::PolicyString ( const SupportedFormats::Ptr & fmts = defaultFormats )

create a "null" Policy formed from an empty string.

Parameters

fmts	a SupportedFormats object to use. An instance encapsulates a configured set of known formats.

Member Function Documentation

◆ getData()

const std::string& lsst.pex::policy::PolicyString::getData ( ) const

inline

return the wrapped policy data as a string

Definition at line 73 of file PolicyString.h.

73 { return _data; }

◆ getFormatName() [1/2]

virtual const std::string& lsst.pex::policy::PolicyString::getFormatName ( )

virtual

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::PolicyString::getFormatName ( ) const

inline

Definition at line 86 of file PolicyString.h.

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

◆ load() [1/2]

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

virtual

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.

◆ load() [2/2]

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

inlinevirtual

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 98 of file PolicyString.h.

98 { const_cast<PolicyString*>(this)->load(policy); }

◆ 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

◆ _data

std::string lsst.pex::policy::PolicyString::_data

protected

the policy data

Definition at line 112 of file PolicyString.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::PolicyString::COMMENT

static

reg-exp for an empty line

Definition at line 102 of file PolicyString.h.

◆ CONTENTID

const boost::regex lsst.pex::policy::PolicyString::CONTENTID

static

reg-exp for the start of a comment

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

Definition at line 106 of file PolicyString.h.

◆ defaultFormats

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

staticinherited

a default set of formats

Definition at line 130 of file PolicySource.h.

◆ SPACE_RE

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

static

Definition at line 101 of file PolicyString.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/PolicyString.h

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ PolicyString() [1/2]

◆ PolicyString() [2/2]

Member Function Documentation

◆ getData()

◆ getFormatName() [1/2]

◆ getFormatName() [2/2]

◆ load() [1/2]

◆ load() [2/2]

◆ serialize()

Member Data Documentation

◆ _data

◆ _formats

◆ COMMENT

◆ CONTENTID

◆ defaultFormats

◆ SPACE_RE