Abstract base class for all formatters. More...

#include <Formatter.h>

Inheritance diagram for lsst::daf::persistence::Formatter:

Public Types
typedef boost::shared_ptr < Formatter >	Ptr

typedef Ptr(*	FactoryPtr )(lsst::pex::policy::Policy::Ptr)

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)

Public Member Functions
virtual	~Formatter (void)

virtual void	write (lsst::daf::base::Persistable const *persistable, Storage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)=0

virtual lsst::daf::base::Persistable *	read (Storage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)=0

virtual void	update (lsst::daf::base::Persistable *persistable, Storage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)=0

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 Formatter::Ptr	lookupFormatter (std::string const &persistableType, lsst::pex::policy::Policy::Ptr policy)

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

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...

Protected Member Functions
	Formatter (std::type_info const &type)

Detailed Description

Abstract base class for all formatters.

Formatters map Persistable subclasses into an appropriate form for output to Storage subclasses and vice versa upon retrieval. They also may use an additional piece of data to select the appropriate data for retrieval.

Subclasses of Formatter must register themselves by creating a static instance of the FormatterRegistration class with the name and type_info of the Persistable class they are formatting and a factory method to create instances of the subclass using a Policy. If they are to be used with boost::serialization, subclasses of Formatter must also implement a public static delegateSerialize() template (or a set of static delegateSerialize() functions for each supported archive type).

Definition at line 79 of file Formatter.h.

Member Typedef Documentation

typedef Ptr(* lsst::daf::persistence::Formatter::FactoryPtr)(lsst::pex::policy::Policy::Ptr)

Pointer to a (static) factory function for a Formatter subclass.

Definition at line 85 of file Formatter.h.

typedef boost::shared_ptr<Formatter> lsst::daf::persistence::Formatter::Ptr

Definition at line 81 of file Formatter.h.

Constructor & Destructor Documentation

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

virtual

Minimal destructor.

Definition at line 74 of file Formatter.cc.

74 {

75 }

lsst::daf::persistence::Formatter::Formatter ( std::type_info const & type )

explicitprotected

Constructor.

Parameters

[in] type typeid() of subclass

Definition at line 68 of file Formatter.cc.

                                              :
     lsst::daf::base::Citizen(type) {
 }

Member Function Documentation

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

static

Lookup Formatter subclass by name of Persistable subclass.

Parameters

[in]	name	Name of Persistable subclass
[in]	policy	Policy for configuring the Formatter

Returns: Shared pointer to Formatter instance

Returned pointer is not owned and should not be deleted.

Definition at line 84 of file Formatter.cc.

                                                           {
     return FormatterRegistry::getInstance().lookupFormatter(name, policy);
 }

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

static

Lookup Formatter subclass by its type_info from typeid().

Parameters

[in]	type	std::type_info of Formatter subclass from typeid()
[in]	policy	Policy for configuring the Formatter

Returns: Shared pointer to Formatter instance

Definition at line 94 of file Formatter.cc.

                                                              {
     return FormatterRegistry::getInstance().lookupFormatter(type, policy);
 }

virtual lsst::daf::base::Persistable* lsst::daf::persistence::Formatter::read	(	Storage::Ptr	storage,
		lsst::daf::base::PropertySet::Ptr	additionalData
	)

pure virtual

Read a Persistable instance from a Storage instance.

Parameters

[in]	storage	Pointer to the Storage instance.
[in]	additionalData	Additional data used to find the proper instance within the Storage.

Returns: Shared pointer to the new Persistable instance.

virtual void lsst::daf::persistence::Formatter::update	(	lsst::daf::base::Persistable *	persistable,
		Storage::Ptr	storage,
		lsst::daf::base::PropertySet::Ptr	additionalData
	)

pure virtual

Update an existing Persistable instance with information from an additional Storage instance.

Parameters

[in,out]	persistable	Pointer to the Persistable instance.
[in]	storage	Shared pointer to the additional Storage instance.
[in]	additionalData	Additional data used to find the proper instance within the Storage.

virtual void lsst::daf::persistence::Formatter::write	(	lsst::daf::base::Persistable const *	persistable,
		Storage::Ptr	storage,
		lsst::daf::base::PropertySet::Ptr	additionalData
	)

pure virtual

Write a Persistable instance to a Storage instance.

Parameters

[in]	persistable	Pointer to the Persistable instance.
[in]	storage	Shared pointer to the Storage instance.
[in]	additionalData	Additional data used to find the proper place to put the instance into the Storage.

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

/home/lsstsw/stack/Linux64/daf_persistence/11.0-1-g7418c06/include/lsst/daf/persistence/Formatter.h
/home/lsstsw/stack/Linux64/daf_persistence/11.0-1-g7418c06/src/Formatter.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation