an abstract factory class for creating PolicyParser instances. More...

#include <PolicyParserFactory.h>

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

Public Types
typedef std::shared_ptr< PolicyParserFactory >	Ptr

Public Member Functions
	PolicyParserFactory ()
	create a factory More...

virtual	~PolicyParserFactory ()
	destroy this factory More...

virtual PolicyParser *	createParser (Policy &policy, bool strict=true) const =0
	create a new PolicyParser class and return a pointer to it. More...

virtual bool	isRecognized (const std::string &leaders) const =0
	analyze the given string assuming contains the leading characters from the data stream and return true if it is recognized as being in the format supported by this parser. More...

virtual const std::string &	getFormatName ()
	return the name for the format supported by the parser More...

Static Public Attributes
static const std::string	UNRECOGNIZED
	an empty string representing an unrecognized format More...

Detailed Description

an abstract factory class for creating PolicyParser instances.

This class is used by the PolicySource class to determine the format of a stream of serialized Policy data and then parse it into a Policy instance. It is intended that for supported each format there is an implementation of this class and a corresponding PolicyParser class.

Definition at line 57 of file PolicyParserFactory.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<PolicyParserFactory> lsst.pex::policy::PolicyParserFactory::Ptr

Definition at line 59 of file PolicyParserFactory.h.

Constructor & Destructor Documentation

◆ PolicyParserFactory()

lsst.pex::policy::PolicyParserFactory::PolicyParserFactory ( )

inline

create a factory

Definition at line 64 of file PolicyParserFactory.h.

64 {}

◆ ~PolicyParserFactory()

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

virtual

destroy this factory

Definition at line 45 of file PolicyParserFactory.cc.

45 {}

Member Function Documentation

◆ createParser()

virtual PolicyParser* lsst.pex::policy::PolicyParserFactory::createParser	(	Policy &	policy,
		bool	strict = `true`
	)		const

pure virtual

create a new PolicyParser class and return a pointer to it.

The caller is responsible for destroying the pointer.

Parameters

policy	the Policy object that data should be loaded 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 is true.

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

◆ getFormatName()

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

virtual

return the name for the format supported by the parser

Reimplemented in lsst.pex::policy::paf::PAFParserFactory.

Definition at line 50 of file PolicyParserFactory.cc.

50 { return UNRECOGNIZED; }

◆ isRecognized()

virtual bool lsst.pex::policy::PolicyParserFactory::isRecognized ( const std::string & leaders ) const

pure virtual

analyze the given string assuming contains the leading characters from the data stream and return true if it is recognized as being in the format supported by this parser.

If it is, return the name of the this format;

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

Member Data Documentation

◆ UNRECOGNIZED

const std::string lsst.pex::policy::PolicyParserFactory::UNRECOGNIZED

static

an empty string representing an unrecognized format

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

Public Types

Public Member Functions

Static Public Attributes