lsst::daf::persistence::Persistence Class Reference

Class implementing object persistence. More...

#include <Persistence.h>

Inheritance diagram for lsst::daf::persistence::Persistence:

Public Types
typedef boost::shared_ptr < Persistence >	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	~Persistence (void)
virtual Storage::Ptr	getPersistStorage (std::string const &storageType, LogicalLocation const &location)
virtual Storage::Ptr	getRetrieveStorage (std::string const &storageType, LogicalLocation const &location)
virtual void	persist (lsst::daf::base::Persistable const &persistable, Storage::List const &storageList, lsst::daf::base::PropertySet::Ptr additionalData)
virtual lsst::daf::base::Persistable::Ptr	retrieve (std::string const &persistableType, Storage::List const &storageList, lsst::daf::base::PropertySet::Ptr additionalData)
virtual lsst::daf::base::Persistable *	unsafeRetrieve (std::string const &persistableType, Storage::List const &storageList, lsst::daf::base::PropertySet::Ptr additionalData)
lsst::pex::policy::Policy::Ptr	getPolicy () const
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 Ptr	getPersistence (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...

Private Member Functions
	Persistence (lsst::pex::policy::Policy::Ptr policy)
	Persistence (Persistence const &)
Persistence &	operator= (Persistence const &)
Storage::Ptr	_getStorage (std::string const &storageType, LogicalLocation const &location, bool persist)

Private Attributes
lsst::pex::policy::Policy::Ptr	_policy
	Pointer to Policy used to configure Persistence. More...

Detailed Description

Class implementing object persistence.

This class persists and retrieves objects by calling Formatter subclasses with a sequence of Storage subclasses that have been configured with LogicalLocations. This class handles all transaction semantics by starting per-Storage transactions, detecting failures, and causing the Storage subclasses to roll back if necessary.

Definition at line 68 of file Persistence.h.

Member Typedef Documentation

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

Definition at line 70 of file Persistence.h.

Constructor & Destructor Documentation

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

virtual

Destructor.

Definition at line 66 of file Persistence.cc.

                              {
}

lsst::daf::persistence::Persistence::Persistence ( lsst::pex::policy::Policy::Ptr  policy )

explicitprivate

Constructor.

Parameters

[in]

policy

Policy to configure the Persistence object

Definition at line 60 of file Persistence.cc.

                                                      :
    lsst::daf::base::Citizen(typeid(*this)), _policy(policy) {
}

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

private

Member Function Documentation

Storage::Ptr lsst::daf::persistence::Persistence::_getStorage ( std::string const &  storageType, LogicalLocation const &  location, bool  persist  )

private

Create a Storage subclass configured for a particular access.

Parameters

[in]	storageType	Name of Storage subclass as registered in StorageRegistry
[in]	location	Location to persist to or retrieve from (subclass-specific)
[in]	persist	True if persisting, false if retrieving

Definition at line 76 of file Persistence.cc.

                                                    {
    lsst::pex::policy::Policy::Ptr policyPtr;
    if (_policy && _policy->exists(storageType)) {
        policyPtr = _policy->getPolicy(storageType);
    }
    return Storage::createInstance(storageType, location, persist, policyPtr);
}

Persistence::Ptr lsst::daf::persistence::Persistence::getPersistence ( lsst::pex::policy::Policy::Ptr  policy )

static

Create a Persistence object.

Parameters

[in]

policy

Policy to configure the Persistence object

Returns

Pointer to a Persistence instance

Definition at line 196 of file Persistence.cc.

                                   {
    return Persistence::Ptr(new Persistence(policy));
}

Storage::Ptr lsst::daf::persistence::Persistence::getPersistStorage ( std::string const &  storageType, LogicalLocation const &  location  )

virtual

Create a Storage subclass configured to persist to a location.

Parameters

[in]	storageType	Name of Storage subclass as registered in StorageRegistry
[in]	location	Location to persist to (subclass-specific)

Definition at line 91 of file Persistence.cc.

                                                                             {
    return _getStorage(storageType, location, true);
}

lsst::pex::policy::Policy::Ptr lsst::daf::persistence::Persistence::getPolicy

(

)

const

Return the policy used to configure the Persistence object

Returns

Pointer to Policy

Definition at line 205 of file Persistence.cc.

{
    return _policy;
}

Storage::Ptr lsst::daf::persistence::Persistence::getRetrieveStorage ( std::string const &  storageType, LogicalLocation const &  location  )

virtual

Create a Storage subclass configured to retrieve from a location.

Parameters

[in]	storageType	Name of Storage subclass as registered in StorageRegistry
[in]	location	Location to retrieve from (subclass-specific)

Definition at line 101 of file Persistence.cc.

                                                                              {
    return _getStorage(storageType, location, false);
}

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

private

void lsst::daf::persistence::Persistence::persist ( lsst::daf::base::Persistable const &  persistable, Storage::List const &  storageList, lsst::daf::base::PropertySet::Ptr  additionalData  )

virtual

Persist a Persistable instance.

Parameters

[in]	persistable	The Persistable instance
[in]	storageList	List of storages to persist to (in order)
[in]	additionalData	Additional information needed to determine the correct place to put data in any of the Storages

Definition at line 112 of file Persistence.cc.

                                              {
    // Get the policies for all Formatters, if present
    std::string policyName = "Formatter";
    lsst::pex::policy::Policy::Ptr policyPtr;
    if (_policy && _policy->exists(policyName)) {
        policyPtr = _policy->getPolicy(policyName);
    }
    // Find the appropriate Formatter.
    Formatter::Ptr f =
        Formatter::lookupFormatter(typeid(persistable), policyPtr);
    // Use the Formatter instance to write the Persistable to each Storage
    // in turn.  Commit the transactions (in order) when all writing is
    // complete.
    for (Storage::List::const_iterator it = storageList.begin();
         it != storageList.end(); ++it) {
        (*it)->startTransaction();
        f->write(&persistable, *it, additionalData);
    }
    for (Storage::List::const_iterator it = storageList.begin();
         it != storageList.end(); ++it) {
        (*it)->endTransaction();
    }
}

lsst::daf::base::Persistable::Ptr lsst::daf::persistence::Persistence::retrieve ( std::string const &  persistableType, Storage::List const &  storageList, lsst::daf::base::PropertySet::Ptr  additionalData  )

virtual

Retrieve a Persistable instance.

Parameters

[in]	persistableType	Name of Persistable type to be retrieved as registered by its Formatter
[in]	storageList	List of storages to retrieve from (in order)
[in]	additionalData	Additional information needed to select the correct data from any of the Storages

Returns

Shared pointer to new Persistable instance

Definition at line 185 of file Persistence.cc.

                                              {
    return lsst::daf::base::Persistable::Ptr(
        unsafeRetrieve(persistableType, storageList, additionalData));
}

lsst::daf::base::Persistable * lsst::daf::persistence::Persistence::unsafeRetrieve ( std::string const &  persistableType, Storage::List const &  storageList, lsst::daf::base::PropertySet::Ptr  additionalData  )

virtual

Retrieve a Persistable instance, returning an unsafe bare pointer. Intended for use by SWIG/Python only.

Parameters

[in]	persistableType	Name of Persistable type to be retrieved as registered by its Formatter
[in]	storageList	List of storages to retrieve from (in order)
[in]	additionalData	Additional information needed to select the correct data from any of the Storages

Returns

Bare pointer to new Persistable instance

Definition at line 147 of file Persistence.cc.

                                              {
    // Get the policies for all Formatters, if present
    std::string policyName = "Formatter";
    lsst::pex::policy::Policy::Ptr policyPtr;
    if (_policy && _policy->exists(policyName)) {
        policyPtr = _policy->getPolicy(policyName);
    }
    // Find the appropriate Formatter.
    Formatter::Ptr f = Formatter::lookupFormatter(persistableType, policyPtr);
    // Use the Formatter instance to read from the first Storage; then update
    // from each additional Storage in turn.
    lsst::daf::base::Persistable* persistable = 0;
    for (Storage::List::const_iterator it = storageList.begin();
         it != storageList.end(); ++it) {
        (*it)->startTransaction();
        if (!persistable) {
            persistable = f->read(*it, additionalData);
        } else {
            f->update(persistable, *it, additionalData);
        }
    }
    for (Storage::List::const_iterator it = storageList.begin();
         it != storageList.end(); ++it) {
        (*it)->endTransaction();
    }
    return persistable;
}

Member Data Documentation

lsst::pex::policy::Policy::Ptr lsst::daf::persistence::Persistence::_policy

private

Pointer to Policy used to configure Persistence.

Definition at line 103 of file Persistence.h.

---

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/Persistence.h
• /home/lsstsw/stack/Linux64/daf_persistence/11.0-1-g7418c06/src/Persistence.cc