Class for XML file storage. More...

#include <XmlStorage.h>

Inheritance diagram for lsst::daf::persistence::XmlStorage:

Public Types
typedef boost::shared_ptr < XmlStorage >	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
	XmlStorage (void)

virtual	~XmlStorage (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::xml_oarchive &	getOArchive (void)

virtual boost::archive::xml_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
	Underlying output stream. More...

boost::scoped_ptr< std::ifstream >	_istream
	Underlying input stream. More...

boost::scoped_ptr < boost::archive::xml_oarchive >	_oarchive
	Boost XML output archive. More...

boost::scoped_ptr < boost::archive::xml_iarchive >	_iarchive
	Boost XML input archive. 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 XML file storage.

Provides Boost XML archives for Formatter subclasses to use.

Definition at line 57 of file XmlStorage.h.

Member Typedef Documentation

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

Definition at line 59 of file XmlStorage.h.

Constructor & Destructor Documentation

lsst::daf::persistence::XmlStorage::XmlStorage ( void )

Constructor.

Definition at line 54 of file XmlStorage.cc.

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

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

virtual

Destructor.

Clean up streams.

Definition at line 62 of file XmlStorage.cc.

62 {

63 }

Member Function Documentation

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

virtual

End a transaction. No transaction support for now, but close streams.

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

Definition at line 97 of file XmlStorage.cc.

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

boost::archive::xml_iarchive & lsst::daf::persistence::XmlStorage::getIArchive ( void )

virtual

Get a boost::serialization XML archive suitable for input.

Returns: Reference to an XML input archive

Definition at line 114 of file XmlStorage.cc.

                                                       {
     return *_iarchive;
 }

boost::archive::xml_oarchive & lsst::daf::persistence::XmlStorage::getOArchive ( void )

virtual

Get a boost::serialization XML archive suitable for output.

Returns: Reference to an XML output archive

Definition at line 107 of file XmlStorage.cc.

                                                       {
     return *_oarchive;
 }

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

virtual

Set the destination to persist to.

Parameters

[in] location Pathname to Boost XML file

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

Definition at line 74 of file XmlStorage.cc.

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

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

virtual

Allow a Policy to be used to configure the Storage.

Parameters

[in] policy

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

Definition at line 68 of file XmlStorage.cc.

68 {

69 }

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

virtual

Set the source to retrieve from.

Parameters

[in] location Pathname to Boost XML file

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

Definition at line 83 of file XmlStorage.cc.

                                                                     {
     _istream.reset(new std::ifstream(location.locString().c_str()));
     _iarchive.reset(new boost::archive::xml_iarchive(*_istream));
 }

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

virtual

Start a transaction. No transaction support for now.

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

Definition at line 91 of file XmlStorage.cc.

91 {

92 }

Member Data Documentation

boost::scoped_ptr<boost::archive::xml_iarchive> lsst::daf::persistence::XmlStorage::_iarchive

private

Boost XML input archive.

Definition at line 81 of file XmlStorage.h.

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

private

Underlying input stream.

Definition at line 77 of file XmlStorage.h.

boost::scoped_ptr<boost::archive::xml_oarchive> lsst::daf::persistence::XmlStorage::_oarchive

private

Boost XML output archive.

Definition at line 79 of file XmlStorage.h.

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

private

Underlying output stream.

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