Class that registers all Formatter subclasses. More...

#include <FormatterRegistry.h>

Inheritance diagram for lsst::daf::persistence::FormatterRegistry:

Public Member Functions
void	registerFormatter (std::string const &persistableName, std::type_info const &persistableType, Formatter::FactoryPtr factory)

Formatter::Ptr	lookupFormatter (std::type_info const &persistableType, lsst::pex::policy::Policy::Ptr policy)

Formatter::Ptr	lookupFormatter (std::string const &persistableName, lsst::pex::policy::Policy::Ptr policy)

Public Member Functions inherited from lsst::daf::base::Citizen
	Citizen (const std::type_info &)

	Citizen (Citizen const &)

	~Citizen ()

Citizen &	operator= (Citizen const &)

std::string	repr () const
	Return a string representation of a Citizen. More...

void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...

memId	getId () const
	Return the Citizen's ID. More...

Static Public Member Functions
static FormatterRegistry &	getInstance (void)

Static Public Member Functions inherited from lsst::daf::base::Citizen
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...

static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...

static int	init ()
	Called once when the memory system is being initialised. More...

static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...

static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...

static const std::vector < const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...

static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...

static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...

static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...

static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...

static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

Private Types
typedef std::map< std::string, Formatter::FactoryPtr >	FactoryMap

typedef std::map< std::string, std::string >	StringMap

Private Member Functions
	FormatterRegistry (void)

	~FormatterRegistry (void)

	FormatterRegistry (FormatterRegistry const &)

FormatterRegistry &	operator= (FormatterRegistry const &)

Private Attributes
FactoryMap	_byName
	Registry of Formatter factories by Persistable name. More...

StringMap	_nameForType
	Registry of Persistable names by std::type_info::name(). More...

Additional Inherited Members
Public Types inherited from lsst::daf::base::Citizen
enum	{ magicSentinel = 0xdeadbeef }

typedef unsigned long	memId
	Type of the block's ID. More...

typedef memId(*	memNewCallback )(const memId cid)
	A function used to register a callback. More...

typedef memId(*	memCallback )(const Citizen *ptr)

Detailed Description

Class that registers all Formatter subclasses.

Allows lookup by Persistable type_info or name.

Definition at line 53 of file FormatterRegistry.h.

Member Typedef Documentation

typedef std::map<std::string, Formatter::FactoryPtr> lsst::daf::persistence::FormatterRegistry::FactoryMap

private

Definition at line 66 of file FormatterRegistry.h.

typedef std::map<std::string, std::string> lsst::daf::persistence::FormatterRegistry::StringMap

private

Definition at line 67 of file FormatterRegistry.h.

Constructor & Destructor Documentation

lsst::daf::persistence::FormatterRegistry::FormatterRegistry ( void )

private

Default constructor.

Definition at line 117 of file FormatterRegistry.cc.

                                          :
     lsst::daf::base::Citizen(typeid(*this)) {
     markPersistent();
 }

lsst::daf::persistence::FormatterRegistry::~FormatterRegistry ( void )

private

Minimal destructor.

Definition at line 124 of file FormatterRegistry.cc.

124 {

125 }

lsst::daf::persistence::FormatterRegistry::FormatterRegistry ( FormatterRegistry const & )

private

Member Function Documentation

FormatterRegistry & lsst::daf::persistence::FormatterRegistry::getInstance ( void )

static

Get a reference to the singleton instance of the FormatterRegistry.

Returns: Reference to the singleton

Uses function-scoped static to ensure proper initialization.

Definition at line 56 of file FormatterRegistry.cc.

                                                       {
     static FormatterRegistry* registry = new FormatterRegistry;
     return *registry;
 }

Formatter::Ptr lsst::daf::persistence::FormatterRegistry::lookupFormatter	(	std::type_info const &	persistableType,
		lsst::pex::policy::Policy::Ptr	policy
	)

Create a new instance of a Formatter subclass given the typeid() of its corresponding Persistable subclass.

Parameters

[in]	persistableType	typeid() of the Persistable subclass
[in]	policy	Policy containing all Formatter policies

Returns: Shared pointer to an instance of the subclass

Definition at line 81 of file FormatterRegistry.cc.

                                    {
     StringMap::const_iterator it = _nameForType.find(persistableType.name());
     if (it == _nameForType.end()) {
         throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
             std::string("No Formatter registered for Persistable type: ") +
             persistableType.name());
     }
     return lookupFormatter(it->second, policy);
 }

Formatter::Ptr lsst::daf::persistence::FormatterRegistry::lookupFormatter	(	std::string const &	persistableName,
		lsst::pex::policy::Policy::Ptr	policy
	)

Create a new instance of a Formatter subclass given the string name of its corresponding Persistable subclass.

Parameters

[in]	persistableName	Name of the Persistable subclass
[in]	policy	Policy containing all Formatter policies

Returns: Shared pointer to an instance of the subclass

Definition at line 99 of file FormatterRegistry.cc.

                                    {
     FactoryMap::const_iterator it = _byName.find(persistableName);
     if (it == _byName.end()) {
         throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
             "No Formatter registered for Persistable name: " +
             persistableName);
     }
     lsst::pex::policy::Policy::Ptr formatterPolicy;
     if (policy && policy->exists(persistableName)) {
         formatterPolicy = policy->getPolicy(persistableName);
     }
     return (*(it->second))(formatterPolicy);
 }

FormatterRegistry& lsst::daf::persistence::FormatterRegistry::operator= ( FormatterRegistry const & )

private

void lsst::daf::persistence::FormatterRegistry::registerFormatter	(	std::string const &	persistableName,
		std::type_info const &	persistableType,
		Formatter::FactoryPtr	factory
	)

Register a factory for a Formatter subclass using the name and type of the Persistable subclass it formats.

Parameters

[in]	persistableName	Name of the Persistable subclass
[in]	persistableType	typeid() of the Persistable subclass
[in]	factory	Factory function for the Formatter, taking a Policy

Definition at line 67 of file FormatterRegistry.cc.

                                  {
     _byName.insert(FactoryMap::value_type(persistableName, factory));
     _nameForType.insert(StringMap::value_type(persistableType.name(),
                                               persistableName));
 }

Member Data Documentation

FactoryMap lsst::daf::persistence::FormatterRegistry::_byName

private

Registry of Formatter factories by Persistable name.

Definition at line 76 of file FormatterRegistry.h.

StringMap lsst::daf::persistence::FormatterRegistry::_nameForType

private

Registry of Persistable names by std::type_info::name().

Definition at line 78 of file FormatterRegistry.h.

The documentation for this class was generated from the following files:

/home/lsstsw/stack/Linux64/daf_persistence/11.0.rc2+8/include/lsst/daf/persistence/FormatterRegistry.h
/home/lsstsw/stack/Linux64/daf_persistence/11.0.rc2+8/src/FormatterRegistry.cc

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation