Abstract base class for storage implementations. More...

#include <Storage.h>

Inheritance diagram for lsst::daf::persistence::Storage:

Public Types
typedef boost::shared_ptr < Storage >	Ptr

typedef std::vector< Ptr >	List

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	~Storage (void)

virtual void	setPolicy (lsst::pex::policy::Policy::Ptr policy)=0

virtual void	setPersistLocation (LogicalLocation const &location)=0

virtual void	setRetrieveLocation (LogicalLocation const &location)=0

virtual void	startTransaction (void)=0

virtual void	endTransaction (void)=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 Ptr	createInstance (std::string const &name, LogicalLocation const &location, bool persist, 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
	Storage (std::type_info const &type)

void	verifyPathName (std::string const &pathName)

Private Member Functions
	Storage (Storage const &)

Storage &	operator= (Storage const &)

Detailed Description

Abstract base class for storage implementations.

All subclasses of this base class must be added to StorageRegistry.

Definition at line 60 of file Storage.h.

Member Typedef Documentation

typedef std::vector<Ptr> lsst::daf::persistence::Storage::List

Definition at line 63 of file Storage.h.

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

Definition at line 62 of file Storage.h.

Constructor & Destructor Documentation

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

virtual

Minimal destructor

Definition at line 65 of file Storage.cc.

65 {

66 }

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

explicitprotected

Constructor.

Parameters

[in] type typeid() of subclass

Definition at line 60 of file Storage.cc.

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

61 }

lsst::daf::base::Citizen

Citizen is a class that should be among all LSST classes base classes, and handles basic memory manag...

Definition: Citizen.h:56

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

private

Member Function Documentation

Storage::Ptr lsst::daf::persistence::Storage::createInstance	(	std::string const &	name,
		LogicalLocation const &	location,
		bool	persist,
		lsst::pex::policy::Policy::Ptr	policy
	)

static

Create and configure a Storage subclass instance.

Parameters

[in]	name	Name of subclass
[in]	location	Location to persist to or retrieve from
[in]	persist	True if persisting, false if retrieving
[in]	policy	Policy used to configure the Storage

Returns: Shared pointer to Storage subclass instance

Definition at line 75 of file Storage.cc.

                                    {
     Storage::Ptr storage = StorageRegistry::getRegistry().createInstance(name);
     storage->setPolicy(policy);
     if (persist) {
         storage->setPersistLocation(location);
     }
     else {
         storage->setRetrieveLocation(location);
     }
     return storage;
 }

virtual void lsst::daf::persistence::Storage::endTransaction ( void )

pure virtual

End an atomic transaction

Implemented in lsst::daf::persistence::DbTsvStorage, lsst::daf::persistence::DbStorage, lsst::daf::persistence::BoostStorage, lsst::daf::persistence::XmlStorage, and lsst::daf::persistence::FitsStorage.

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

private

virtual void lsst::daf::persistence::Storage::setPersistLocation ( LogicalLocation const & location )

pure virtual

Set the destination for persistence.

Parameters

[in] location Location to persist to.

Exclusive with setRetrieveLocation().

Implemented in lsst::daf::persistence::DbTsvStorage, lsst::daf::persistence::DbStorage, lsst::daf::persistence::BoostStorage, lsst::daf::persistence::XmlStorage, and lsst::daf::persistence::FitsStorage.

virtual void lsst::daf::persistence::Storage::setPolicy ( lsst::pex::policy::Policy::Ptr policy )

pure virtual

Allow a Policy to be used to configure the Storage.

Parameters

[in] policy Should be called first, after construction.

Implemented in lsst::daf::persistence::DbTsvStorage, lsst::daf::persistence::DbStorage, lsst::daf::persistence::BoostStorage, lsst::daf::persistence::XmlStorage, and lsst::daf::persistence::FitsStorage.

virtual void lsst::daf::persistence::Storage::setRetrieveLocation ( LogicalLocation const & location )

pure virtual

Set the source for retrieval.

Parameters

[in] location Location to retrieve from.

Exclusive with setPersistLocation().

Implemented in lsst::daf::persistence::DbTsvStorage, lsst::daf::persistence::DbStorage, lsst::daf::persistence::BoostStorage, lsst::daf::persistence::XmlStorage, and lsst::daf::persistence::FitsStorage.

virtual void lsst::daf::persistence::Storage::startTransaction ( void )

pure virtual

Begin an atomic transaction

Implemented in lsst::daf::persistence::DbTsvStorage, lsst::daf::persistence::DbStorage, lsst::daf::persistence::BoostStorage, lsst::daf::persistence::XmlStorage, and lsst::daf::persistence::FitsStorage.

void lsst::daf::persistence::Storage::verifyPathName ( std::string const & name )

protected

Ensure that all directories along a path exist, creating them if necessary.

Parameters

[in] name Pathname to file to be created

Definition at line 93 of file Storage.cc.

                                                   {
     // Get the directory by stripping off anything after the last slash.
     std::string::size_type pos = name.find_last_of('/');
     if (pos == std::string::npos) return;
     std::string dirName = name.substr(0, pos);
 
     // Check to see if the directory exists.
     struct stat buf;
     int ret = ::stat(dirName.c_str(), &buf);
 
     if (ret == -1 && errno == ENOENT) {
         // It doesn't; check its parent and then create it.
         verifyPathName(dirName);
 
         ret = ::mkdir(dirName.c_str(), 0777);
 
         // If it already exists, we're OK; otherwise, throw an exception.
         if (ret == -1 && errno != EEXIST) {
             throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError,
                 dirName + ": Error creating directory = " + std::strerror(errno));
         }
     }
     else if (ret == -1) {
         // We couldn't read the (existing) directory for some reason.
         throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError,
             dirName + ": Error searching for directory = " + std::strerror(errno));
     }
     else if (!S_ISDIR(buf.st_mode)) {
         // It's not a directory.
         throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError,
             dirName + ": Non-directory in path");
     }
 }

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation