lsst.pex::policy::SupportedFormats Class Reference

a list of supported Policy formats. More...

#include <SupportedFormats.h>

Public Types
typedef std::shared_ptr< SupportedFormats >	Ptr

Public Member Functions
	SupportedFormats ()
void	registerFormat (const PolicyParserFactory::Ptr &factory)
	register a factory method for policy format parsers More...
const std::string &	recognizeType (const std::string &leaders) const
	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...
bool	supports (const std::string &name) const
	return true if the name resolves to a registered format More...
PolicyParserFactory::Ptr	getFactory (const std::string &name) const
	get a pointer to a factory with a given name. More...
int	size ()
	return the number formats currently registered More...

Static Public Member Functions
static void	initDefaultFormats (SupportedFormats &sf)
	initialize a given SupportFormats instance with the formats known by default. More...

Detailed Description

a list of supported Policy formats.

It can be used to determine the format type for a Policy data stream.

Definition at line 52 of file SupportedFormats.h.

Member Typedef Documentation

Ptr

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

Definition at line 54 of file SupportedFormats.h.

Constructor & Destructor Documentation

SupportedFormats()

lsst.pex::policy::SupportedFormats::SupportedFormats ( )

inline

Definition at line 58 of file SupportedFormats.h.

: _formats() {}

Member Function Documentation

getFactory()

PolicyParserFactory::Ptr lsst.pex::policy::SupportedFormats::getFactory

(

const std::string &

name

)

const

get a pointer to a factory with a given name.

A null pointer is returned if the name is not recognized.

Definition at line 74 of file SupportedFormats.cc.

                                                                               {
    SupportedFormats* me = const_cast<SupportedFormats*>(this);
 
    Lookup::iterator found = me->_formats.find(name);
    return ((found != me->_formats.end()) ? found->second : PolicyParserFactory::Ptr());
}

initDefaultFormats()

void lsst.pex::policy::SupportedFormats::initDefaultFormats ( SupportedFormats &  sf )

static

initialize a given SupportFormats instance with the formats known by default.

Definition at line 40 of file SupportedFormats.cc.

                                                              {
    sf.registerFormat(PolicyParserFactory::Ptr(new PAFParserFactory()));
}

recognizeType()

const std::string & lsst.pex::policy::SupportedFormats::recognizeType

(

const std::string &

leaders

)

const

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.

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

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

If it is, return the name of the this format; if not return an empty string.

Definition at line 61 of file SupportedFormats.cc.

                                                                               {
    Lookup::const_iterator f;
    for (f = _formats.begin(); f != _formats.end(); ++f) {
        if (f->second->isRecognized(leaders)) return f->second->getFormatName();
    }
 
    return PolicyParserFactory::UNRECOGNIZED;
}

registerFormat()

void lsst.pex::policy::SupportedFormats::registerFormat

(

const PolicyParserFactory::Ptr &

factory

)

register a factory method for policy format parsers

Definition at line 47 of file SupportedFormats.cc.

                                                                           {
    if (factory.get() == 0)
        throw LSST_EXCEPT(pexExcept::RuntimeError,
                          std::string("attempt to register null ") + "PolicyParserFactory pointer");
 
    _formats[factory->getFormatName()] = factory;
}

size()

int lsst.pex::policy::SupportedFormats::size ( )

inline

return the number formats currently registered

Definition at line 93 of file SupportedFormats.h.

{ return _formats.size(); }

supports()

bool lsst.pex::policy::SupportedFormats::supports ( const std::string &  name ) const

inline

return true if the name resolves to a registered format

Definition at line 76 of file SupportedFormats.h.

{ return (_formats.find(name) != _formats.end()); }

---

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/SupportedFormats.h
• /j/snowflake/release/lsstsw/stack/cb4e2dc/Linux64/pex_policy/20.0.0-1-gb058bd0+46a6078777/src/SupportedFormats.cc