Class for boost::serialization storage. More...

#include <BoostStorage.h>

Inheritance diagram for lsst::daf::persistence::BoostStorage:

Public Types
typedef boost::shared_ptr < BoostStorage >	Ptr

Public Types inherited from lsst::daf::persistence::Storage
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
	BoostStorage (void)

virtual	~BoostStorage (void)

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

virtual void	setPersistLocation (LogicalLocation const &location)

virtual void	setRetrieveLocation (LogicalLocation const &location)

virtual void	startTransaction (void)

virtual void	endTransaction (void)

virtual boost::archive::text_oarchive &	getOArchive (void)

virtual boost::archive::text_iarchive &	getIArchive (void)

Public Member Functions inherited from lsst::daf::persistence::Storage
virtual	~Storage (void)

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

Private Attributes
boost::scoped_ptr< std::ofstream >	_ostream
	Output stream. More...

boost::scoped_ptr< std::ifstream >	_istream
	Input stream. More...

boost::scoped_ptr < boost::archive::text_oarchive >	_oarchive
	boost::serialization archive wrapper for output stream. More...

boost::scoped_ptr < boost::archive::text_iarchive >	_iarchive
	boost::serialization archive wrapper for input stream. More...

Additional Inherited Members
Static Public Member Functions inherited from lsst::daf::persistence::Storage
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 inherited from lsst::daf::persistence::Storage
	Storage (std::type_info const &type)

void	verifyPathName (std::string const &pathName)

Detailed Description

Class for boost::serialization storage.

Uses boost::serialization to persist to files.

Definition at line 58 of file BoostStorage.h.

Member Typedef Documentation

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

Definition at line 60 of file BoostStorage.h.

Constructor & Destructor Documentation

lsst::daf::persistence::BoostStorage::BoostStorage ( void )

Constructor.

Definition at line 57 of file BoostStorage.cc.

                                : Storage(typeid(*this)),
     _ostream(0), _istream(0), _oarchive(0), _iarchive(0) {
 }

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

virtual

Destructor.

Definition at line 63 of file BoostStorage.cc.

63 {

64 }

Member Function Documentation

void lsst::daf::persistence::BoostStorage::endTransaction ( void )

virtual

End a transaction. No transaction support for now.

Implements lsst::daf::persistence::Storage.

Definition at line 104 of file BoostStorage.cc.

                                       {
     _oarchive.reset(0);
     _ostream.reset(0);
     _iarchive.reset(0);
     _istream.reset(0);
 }

boost::archive::text_iarchive & lsst::daf::persistence::BoostStorage::getIArchive ( void )

virtual

Get a boost::serialization archive suitable for input.

Returns: Reference to a text input archive

Definition at line 121 of file BoostStorage.cc.

                                                          {
     return *_iarchive;
 }

boost::archive::text_oarchive & lsst::daf::persistence::BoostStorage::getOArchive ( void )

virtual

Get a boost::serialization archive suitable for output.

Returns: Reference to a text output archive

Definition at line 114 of file BoostStorage.cc.

                                                          {
     return *_oarchive;
 }

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

virtual

Set the destination of the serialization file for persistence.

Parameters

[in] location Pathname to write to.

Implements lsst::daf::persistence::Storage.

Definition at line 75 of file BoostStorage.cc.

                                                                      {
     verifyPathName(location.locString());
     _ostream.reset(new std::ofstream(location.locString().c_str()));
     _oarchive.reset(new boost::archive::text_oarchive(*_ostream));
 }

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

virtual

Allow a Policy to be used to configure the BoostStorage.

Parameters

[in] policy

Implements lsst::daf::persistence::Storage.

Definition at line 69 of file BoostStorage.cc.

69 {

70 }

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

virtual

Set the source of the serialization file for retrieval.

Parameters

[in] location Pathname to read from.

Implements lsst::daf::persistence::Storage.

Definition at line 84 of file BoostStorage.cc.

                                                                       {
     char const* fname = location.locString().c_str();
     if (::access(fname, R_OK | F_OK) != 0) {
         throw LSST_EXCEPT(pexExcept::NotFoundError,
                           (boost::format("Unable to access file: %1%")
                            % fname).str());
     }
     _istream.reset(new std::ifstream(fname));
     _iarchive.reset(new boost::archive::text_iarchive(*_istream));
 }

void lsst::daf::persistence::BoostStorage::startTransaction ( void )

virtual

Start a transaction. No transaction support for now.

Implements lsst::daf::persistence::Storage.

Definition at line 98 of file BoostStorage.cc.

98 {

99 }

Member Data Documentation

boost::scoped_ptr<boost::archive::text_iarchive> lsst::daf::persistence::BoostStorage::_iarchive

private

boost::serialization archive wrapper for input stream.

Definition at line 80 of file BoostStorage.h.

boost::scoped_ptr<std::ifstream> lsst::daf::persistence::BoostStorage::_istream

private

Input stream.

Definition at line 77 of file BoostStorage.h.

boost::scoped_ptr<boost::archive::text_oarchive> lsst::daf::persistence::BoostStorage::_oarchive

private

boost::serialization archive wrapper for output stream.

Definition at line 78 of file BoostStorage.h.

boost::scoped_ptr<std::ofstream> lsst::daf::persistence::BoostStorage::_ostream

private

Output stream.

Definition at line 76 of file BoostStorage.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/BoostStorage.h
/home/lsstsw/stack/Linux64/daf_persistence/11.0-1-g7418c06/src/BoostStorage.cc

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation