lsst::pex::policy::SupportedFormats Class Reference

a list of supported Policy formats. It can be used to determine the format type for a Policy data stream. More...

#include <SupportedFormats.h>

Public Types
typedef boost::shared_ptr < SupportedFormats >	Ptr

Public Member Functions
	SupportedFormats ()
void	registerFormat (const PolicyParserFactory::Ptr &factory)
const std::string &	recognizeType (const std::string &leaders) const
bool	supports (const std::string &name) const
PolicyParserFactory::Ptr	getFactory (const std::string &name) const
int	size ()

Static Public Member Functions
static void	initDefaultFormats (SupportedFormats &sf)

Private Types
typedef std::map< std::string, PolicyParserFactory::Ptr >	Lookup

Private Attributes
Lookup	_formats

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

typedef std::map<std::string, PolicyParserFactory::Ptr> lsst::pex::policy::SupportedFormats::Lookup

private

Definition at line 99 of file SupportedFormats.h.

typedef boost::shared_ptr<SupportedFormats> lsst::pex::policy::SupportedFormats::Ptr

Definition at line 55 of file SupportedFormats.h.

Constructor & Destructor Documentation

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

inline

Definition at line 59 of file SupportedFormats.h.

: _formats() { }

Member Function Documentation

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 80 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());
}

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()));
}

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. If it is, return the name of the this format;

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 not return an empty string.

Definition at line 64 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;
}

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;
}

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

inline

return the number formats currently registered

Definition at line 96 of file SupportedFormats.h.

{ return _formats.size(); } 

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 77 of file SupportedFormats.h.

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

Member Data Documentation

Lookup lsst::pex::policy::SupportedFormats::_formats

private

Definition at line 100 of file SupportedFormats.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/SupportedFormats.h
• /home/lsstsw/stack/Linux64/pex_policy/11.0+1/src/SupportedFormats.cc