lsst.pex::policy::paf::PAFParser Class Reference

a parser for reading PAF-formatted data into a Policy object More...

#include <PAFParser.h>

Inheritance diagram for lsst.pex::policy::paf::PAFParser:

Public Member Functions
	PAFParser (Policy &policy)
	create a parser to load a Policy More...
	PAFParser (Policy &policy, bool strict)
	create a parser to load a Policy More...
virtual	~PAFParser ()
	delete this parser More...
virtual int	parse (std::istream &is)
	parse the data found on the given stream 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...
Policy &	getPolicy ()
	return the policy object More...
const Policy &	getPolicy () const

Protected Attributes
Policy &	_pol
bool	_strict

Detailed Description

a parser for reading PAF-formatted data into a Policy object

Definition at line 53 of file PAFParser.h.

Constructor & Destructor Documentation

PAFParser() [1/2]

lsst.pex::policy::paf::PAFParser::PAFParser

(

Policy &

policy

)

create a parser to load a Policy

Parameters

policy

the Policy object to load the parsed data into

PAFParser() [2/2]

lsst.pex::policy::paf::PAFParser::PAFParser	(	Policy &	policy,
		bool	strict
	)

create a parser to load a Policy

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. The default (set by PolicyParser) is true.

~PAFParser()

virtual lsst.pex::policy::paf::PAFParser::~PAFParser ( )

virtual

delete this parser

Member Function Documentation

getPolicy() [1/2]

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

inlineinherited

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

inlineinherited

Definition at line 91 of file PolicyParser.h.

{ return _pol; }

isStrict()

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

inlineinherited

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::paf::PAFParser::parse ( std::istream &  is )

virtual

parse the data found on the given stream

Parameters

is	the stream to read PAF-encoded data from

Returns

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

Implements lsst.pex::policy::PolicyParser.

setStrict()

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

inlineinherited

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

protectedinherited

Definition at line 95 of file PolicyParser.h.

_strict

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

protectedinherited

Definition at line 96 of file PolicyParser.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/paf/PAFParser.h