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)
	Create a Parser attached to a policy object to be loaded. More...
virtual	~PolicyParser ()
	destroy this factory More...
bool	isStrict ()
	return true if this parser will be strict in adhering to syntax rules. More...
void	setStrict (bool strict)
	set whether this parser will be strict in adhering to syntax rules. More...
virtual int	parse (std::istream &is)=0
	parse data from the input stream and load results into the attached Policy. More...
Policy &	getPolicy ()
	return the policy object More...
const Policy &	getPolicy () const

Protected Attributes
Policy &	_pol
bool	_strict

Detailed Description

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

Definition at line 46 of file PolicyParser.h.

Constructor & Destructor Documentation

PolicyParser()

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 56 of file PolicyParser.h.

: _pol(policy), _strict(strict) {}

~PolicyParser()

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

virtual

destroy this factory

Definition at line 43 of file PolicyParser.cc.

{}

Member Function Documentation

getPolicy() [1/2]

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

inline

return the policy object

Definition at line 90 of file PolicyParser.h.

{ return _pol; }

getPolicy() [2/2]

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

inline

Definition at line 91 of file PolicyParser.h.

{ return _pol; }

isStrict()

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 68 of file PolicyParser.h.

{ return _strict; }

parse()

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.

setStrict()

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 75 of file PolicyParser.h.

{ _strict = strict; }

Member Data Documentation

_pol

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

protected

Definition at line 95 of file PolicyParser.h.

_strict

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

protected

Definition at line 96 of file PolicyParser.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/PolicyParser.h
• /j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/pex_policy/20.0.0-1-gb058bd0+46a6078777/src/PolicyParser.cc