lsst.pex::policy::PolicySource Class Reference

an abstract class representing a source of serialized Policy parameter data. More...

#include <PolicySource.h>

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

Public Member Functions
	PolicySource (SupportedFormats::Ptr fmts=defaultFormats)
	create a Policy file that points a file with given path. More...
virtual	~PolicySource ()
	destroy the source More...
virtual const std::string &	getFormatName ()=0
	return the name of the format that the data is stored in. More...
virtual void	load (Policy &policy) const =0
	load the data from this Policy source into a Policy object More...
virtual void	load (Policy &policy)=0

Static Public Attributes
static SupportedFormats::Ptr	defaultFormats
	a default set of formats More...

Protected Attributes
SupportedFormats::Ptr	_formats

Detailed Description

an abstract class representing a source of serialized Policy parameter data.

This might be a file or a stream; sub-classes handle the different possibilities. This class can determine which format the data is in (which may involve reading the first few characters) and load it into a Policy.

Definition at line 52 of file PolicySource.h.

Constructor & Destructor Documentation

PolicySource()

lsst.pex::policy::PolicySource::PolicySource ( SupportedFormats::Ptr  fmts = defaultFormats )

inline

create a Policy file that points a file with given path.

Parameters

fmts	the list of formats to support

Definition at line 58 of file PolicySource.h.

                                                            : _formats(fmts) {
        if (defaultFormats->size() == 0) SupportedFormats::initDefaultFormats(*defaultFormats);
    }

~PolicySource()

lsst.pex::policy::PolicySource::~PolicySource ( )

virtual

destroy the source

Definition at line 35 of file PolicySource.cc.

{}

Member Function Documentation

getFormatName()

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

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

Exceptions

IOError

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

Implemented in lsst.pex::policy::PolicyFile, and lsst.pex::policy::PolicyString.

load() [1/2]

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

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

Implemented in lsst.pex::policy::PolicyFile, lsst.pex::policy::DefaultPolicyFile, and lsst.pex::policy::PolicyString.

load() [2/2]

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

pure virtual

Implemented in lsst.pex::policy::PolicyFile, and lsst.pex::policy::PolicyString.

Member Data Documentation

_formats

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

protected

Definition at line 135 of file PolicySource.h.

defaultFormats

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

static

a default set of formats

Definition at line 130 of file PolicySource.h.

---

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

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