Abstract base class for all formatters. More...

#include <Formatter.h>

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

Public Types
typedef std::shared_ptr< Formatter >	Ptr

typedef Ptr(*	FactoryPtr) (lsst::pex::policy::Policy::Ptr)
	Pointer to a (static) factory function for a Formatter subclass. More...

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)
	Minimal destructor. More...

virtual void	write (lsst::daf::base::Persistable const *persistable, FormatterStorage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)=0
	Write a Persistable instance to a FormatterStorage instance. More...

virtual lsst::daf::base::Persistable *	read (FormatterStorage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)=0
	Read a Persistable instance from a FormatterStorage instance. More...

virtual void	update (lsst::daf::base::Persistable *persistable, FormatterStorage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)=0
	Update an existing Persistable instance with information from an additional FormatterStorage instance. More...

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)
	Lookup Formatter subclass by name of Persistable subclass. More...

static Formatter::Ptr	lookupFormatter (std::type_info const &persistableType, lsst::pex::policy::Policy::Ptr policy)
	Lookup Formatter subclass by its type_info from typeid(). More...

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

Census
Provide a list of current Citizens
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...

callbackIDs
Set callback Ids. The old Id is returned
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...

callbacks
Set the New/Delete callback functions; in each case the previously installed callback is returned. These callback functions return a value which is Added to the previously registered id. The default callback functions are called default{New,Delete}Callback; you may want to set a break point in these callbacks from your favourite debugger
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)
	Constructor. More...

Detailed Description

Abstract base class for all formatters.

Formatters map Persistable subclasses into an appropriate form for output to FormatterStorage 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

◆ FactoryPtr

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.

◆ memCallback

typedef memId(* lsst::daf::base::Citizen::memCallback) (const Citizen *ptr)

inherited

Definition at line 61 of file Citizen.h.

◆ memId

typedef unsigned long lsst::daf::base::Citizen::memId

inherited

Type of the block's ID.

Definition at line 58 of file Citizen.h.

◆ memNewCallback

typedef memId(* lsst::daf::base::Citizen::memNewCallback) (const memId cid)

inherited

A function used to register a callback.

Definition at line 60 of file Citizen.h.

◆ Ptr

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

Definition at line 81 of file Formatter.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

Enumerator
magicSentinel

Definition at line 88 of file Citizen.h.

88 { magicSentinel = 0xdeadbeef };

lsst::daf::base::Citizen::magicSentinel

Definition: Citizen.h:88

Constructor & Destructor Documentation

◆ ~Formatter()

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

virtual

Minimal destructor.

Definition at line 74 of file Formatter.cc.

74 {

75 }

◆ Formatter()

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

◆ census() [1/3]

int lsst::daf::base::Citizen::census	(	int	,
		memId	startingMemId = `0`
	)

staticinherited

How many active Citizens are there?

Parameters

startingMemId Don't print Citizens with lower IDs

Definition at line 238 of file Citizen.cc.

   {
     if (startingMemId == 0) {  // easy
         ReadGuard guard(citizenLock);
         return _activeCitizens.size();
     }
 
     int n = 0;
     ReadGuard guard(citizenLock);
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         if (cur->first->_CitizenId >= startingMemId) {
             n++;
         }
     }
 
     return n;
 }

◆ census() [2/3]

void lsst::daf::base::Citizen::census	(	std::ostream &	stream,
		memId	startingMemId = `0`
	)

staticinherited

Print a list of all active Citizens to stream, sorted by ID.

Parameters

stream	stream to print to
startingMemId	Don't print Citizens with lower IDs

Definition at line 259 of file Citizen.cc.

   {
     ReadGuard guard(citizenLock);
 
     std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census());
 
     for (std::vector<Citizen const*>::const_iterator citizen = leaks->begin(), end = leaks->end();
          citizen != end; ++citizen) {
         if ((*citizen)->getId() >= startingMemId) {
             stream << (*citizen)->repr() << "\n";
         }
     }
 }

◆ census() [3/3]

std::vector< dafBase::Citizen const * > const * lsst::daf::base::Citizen::census ( )

staticinherited

Return a (newly allocated) std::vector of active Citizens sorted by ID.

You are responsible for deleting it; or you can say std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census()); and not bother (that becomes std::unique_ptr in C++11)

Definition at line 287 of file Citizen.cc.

                                                                {
     std::vector<Citizen const*>* vec = new std::vector<Citizen const*>(0);
     ReadGuard guard(citizenLock);
     vec->reserve(_activeCitizens.size());
 
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         vec->push_back(dynamic_cast<Citizen const*>(cur->first));
     }
 
     std::sort(vec->begin(), vec->end(), cmpId);
 
     return vec;
 }

◆ getId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getId ( ) const

inherited

Return the Citizen's ID.

Definition at line 206 of file Citizen.cc.

206 { return _CitizenId; }

◆ getNextMemId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getNextMemId ( )

staticinherited

Return the memId of the next object to be allocated.

Definition at line 209 of file Citizen.cc.

209 { return _nextMemId(); }

◆ hasBeenCorrupted()

bool lsst::daf::base::Citizen::hasBeenCorrupted ( )

staticinherited

Check all allocated blocks for corruption.

Definition at line 316 of file Citizen.cc.

                                       {
     ReadGuard guard(citizenLock);
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         if (cur->first->_hasBeenCorrupted()) {
             return true;
         }
     }
     for (table::iterator cur = _persistentCitizens.begin(); cur != _persistentCitizens.end(); cur++) {
         if (cur->first->_hasBeenCorrupted()) {
             return true;
         }
     }
 
     return false;
 }

◆ init()

int lsst::daf::base::Citizen::init ( )

staticinherited

Called once when the memory system is being initialised.

Definition at line 196 of file Citizen.cc.

                          {
     volatile int dummy = 1;
     return dummy;
 }

◆ lookupFormatter() [1/2]

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

◆ lookupFormatter() [2/2]

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

◆ markPersistent()

void lsst::daf::base::Citizen::markPersistent ( void )

inherited

Mark a Citizen as persistent and not destroyed until process end.

Definition at line 225 of file Citizen.cc.

                                         {
     WriteGuard guard(citizenLock);
     _persistentCitizens[this] = _activeCitizens[this];
     _activeCitizens.erase(this);
 }

◆ read()

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

pure virtual

Read a Persistable instance from a FormatterStorage instance.

Parameters

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

Returns: Shared pointer to the new Persistable instance.

◆ repr()

std::string lsst::daf::base::Citizen::repr ( ) const

inherited

Return a string representation of a Citizen.

Definition at line 219 of file Citizen.cc.

                                      {
     return boost::str(boost::format("%d: %08x %s") % _CitizenId % this %
                       lsst::utils::demangleType(_typeName));
 }

◆ setCorruptionCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setCorruptionCallback ( Citizen::memCallback func )

staticinherited

Set the CorruptionCallback function.

Parameters

func	function be called when block is found to be corrupted

Definition at line 391 of file Citizen.cc.

   {
     Citizen::memCallback old = _corruptionCallback;
     _corruptionCallback = func;
 
     return old;
 }

◆ setDeleteCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setDeleteCallback ( Citizen::memCallback func )

staticinherited

Set the DeleteCallback function.

Parameters

func	function be called when desired block is deleted

Definition at line 381 of file Citizen.cc.

   {
     Citizen::memCallback old = _deleteCallback;
     _deleteCallback = func;
 
     return old;
 }

◆ setDeleteCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setDeleteCallbackId ( Citizen::memId id )

staticinherited

Call the current DeleteCallback when block is deleted.

Parameters

id	Desired ID

Definition at line 347 of file Citizen.cc.

   {
     WriteGuard guard(citizenLock);
     Citizen::memId oldId = _deleteId;
     _deleteId = id;
 
     return oldId;
 }

◆ setNewCallback()

dafBase::Citizen::memNewCallback lsst::daf::base::Citizen::setNewCallback ( Citizen::memNewCallback func )

staticinherited

Set the NewCallback function.

Parameters

func	The new function to be called when a designated block is allocated

Definition at line 371 of file Citizen.cc.

   {
     Citizen::memNewCallback old = _newCallback;
     _newCallback = func;
 
     return old;
 }

◆ setNewCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setNewCallbackId ( Citizen::memId id )

staticinherited

Call the NewCallback when block is allocated.

Parameters

id	Desired ID

Definition at line 337 of file Citizen.cc.

   {
     WriteGuard guard(citizenLock);
     Citizen::memId oldId = _newId;
     _newId = id;
 
     return oldId;
 }

◆ update()

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

pure virtual

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

Parameters

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

◆ write()

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

pure virtual

Write a Persistable instance to a FormatterStorage instance.

Parameters

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

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

/j/snowflake/release/lsstsw/stack/Linux64/daf_persistence/16.0-8-gfd407c0+5/include/lsst/daf/persistence/Formatter.h
/j/snowflake/release/lsstsw/stack/Linux64/daf_persistence/16.0-8-gfd407c0+5/src/Formatter.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ FactoryPtr

◆ memCallback

◆ memId

◆ memNewCallback

◆ Ptr

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ ~Formatter()

◆ Formatter()

Member Function Documentation

◆ census() [1/3]

◆ census() [2/3]

◆ census() [3/3]

◆ getId()

◆ getNextMemId()

◆ hasBeenCorrupted()

◆ init()

◆ lookupFormatter() [1/2]

◆ lookupFormatter() [2/2]

◆ markPersistent()

◆ read()

◆ repr()

◆ setCorruptionCallback()

◆ setDeleteCallback()

◆ setDeleteCallbackId()

◆ setNewCallback()

◆ setNewCallbackId()

◆ update()

◆ write()