lsst::pex::policy::PolicyParser Class Reference

an abstract class for parsing serialized Policy data and loading it into a Policy object. More...

#include <PolicyParser.h>

Inheritance diagram for lsst::pex::policy::PolicyParser:

Public Member Functions
	PolicyParser (Policy &policy, bool strict=true)
virtual	~PolicyParser ()
bool	isStrict ()
void	setStrict (bool strict)
virtual int	parse (std::istream &is)=0
Policy &	getPolicy ()
const Policy &	getPolicy () const
Public Member Functions inherited from lsst::daf::base::Citizen
	Citizen (const std::type_info &)
	Citizen (Citizen const &)
	~Citizen ()
Citizen &	operator= (Citizen 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...

Protected Attributes
Policy &	_pol
bool	_strict

Additional Inherited Members
Public Types inherited from lsst::daf::base::Citizen
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)
Static Public Member Functions inherited from lsst::daf::base::Citizen
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...
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...
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...
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...

Detailed Description

an abstract class for parsing serialized Policy data and loading it into a Policy object.

Definition at line 47 of file PolicyParser.h.

Constructor & Destructor Documentation

lsst::pex::policy::PolicyParser::PolicyParser ( Policy &  policy, bool  strict = true  )

inline

Create a Parser attached to a policy object to be loaded.

Parameters

policy	the Policy object to load the parsed data into
strict	if true, be strict in reporting errors in file contents and syntax. If false, errors will be ignored if possible; often, such errors will result in some data not getting loaded.

Definition at line 58 of file PolicyParser.h.

        : lsst::daf::base::Citizen(typeid(this)), _pol(policy), _strict(strict) { }

lsst::pex::policy::PolicyParser::~PolicyParser ( )

virtual

destroy this factory

Definition at line 43 of file PolicyParser.cc.

{ }

Member Function Documentation

Policy& lsst::pex::policy::PolicyParser::getPolicy ( )

inline

return the policy object

Definition at line 93 of file PolicyParser.h.

{ return _pol; }

const Policy& lsst::pex::policy::PolicyParser::getPolicy ( ) const

inline

return the policy object

Definition at line 94 of file PolicyParser.h.

{ return _pol; }

bool lsst::pex::policy::PolicyParser::isStrict ( )

inline

return true if this parser will be strict in adhering to syntax rules. In this case, exceptions will be thrown if any syntax errors are detected. Otherwise, some syntax errors may be ignored.

Definition at line 71 of file PolicyParser.h.

{ return _strict; }

virtual int lsst::pex::policy::PolicyParser::parse ( std::istream &  is )

pure virtual

parse data from the input stream and load results into the attached Policy.

Parameters

is	the stream to read encoded data from

Returns

int the number of parameters values loaded. This does not include sub-Policy objects.

Implemented in lsst::pex::policy::paf::PAFParser.

void lsst::pex::policy::PolicyParser::setStrict ( bool  strict )

inline

set whether this parser will be strict in adhering to syntax rules. If set to true, exceptions will be thrown if any syntax errors are detected. Otherwise, some syntax errors may be ignored.

Definition at line 78 of file PolicyParser.h.

{ _strict = strict; }

Member Data Documentation

Policy& lsst::pex::policy::PolicyParser::_pol

protected

Definition at line 99 of file PolicyParser.h.

bool lsst::pex::policy::PolicyParser::_strict

protected

Definition at line 100 of file PolicyParser.h.

---

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

• /home/lsstsw/stack/Linux64/pex_policy/11.0+1/include/lsst/pex/policy/PolicyParser.h
• /home/lsstsw/stack/Linux64/pex_policy/11.0+1/src/PolicyParser.cc