lsst.daf.persistence  13.0-40-g460649b+6
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
lsst::daf::persistence::BoostStorage Class Reference

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

#include <BoostStorage.h>

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

Public Types

typedef std::shared_ptr< BoostStoragePtr
 
typedef std::vector< PtrList
 

Public Member Functions

 BoostStorage (void)
 Constructor. More...
 
virtual ~BoostStorage (void)
 Destructor. More...
 
virtual void setPolicy (lsst::pex::policy::Policy::Ptr policy)
 Allow a Policy to be used to configure the BoostStorage. More...
 
virtual void setPersistLocation (LogicalLocation const &location)
 Set the destination of the serialization file for persistence. More...
 
virtual void setRetrieveLocation (LogicalLocation const &location)
 Set the source of the serialization file for retrieval. More...
 
virtual void startTransaction (void)
 Start a transaction. More...
 
virtual void endTransaction (void)
 End a transaction. More...
 
virtual boost::archive::text_oarchive & getOArchive (void)
 Get a boost::serialization archive suitable for output. More...
 
virtual boost::archive::text_iarchive & getIArchive (void)
 Get a boost::serialization archive suitable for input. More...
 

Static Public Member Functions

static Ptr createInstance (std::string const &name, LogicalLocation const &location, bool persist, lsst::pex::policy::Policy::Ptr policy)
 Create and configure a FormatterStorage subclass instance. More...
 

Protected Member Functions

void verifyPathName (std::string const &pathName)
 Ensure that all directories along a path exist, creating them if necessary. More...
 

Detailed Description

Class for boost::serialization storage.

Uses boost::serialization to persist to files.

Definition at line 59 of file BoostStorage.h.

Member Typedef Documentation

◆ List

typedef std::vector<Ptr> lsst::daf::persistence::FormatterStorage::List
inherited

Definition at line 63 of file FormatterStorage.h.

◆ Ptr

Definition at line 61 of file BoostStorage.h.

Constructor & Destructor Documentation

◆ BoostStorage()

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

Constructor.

Definition at line 57 of file BoostStorage.cc.

◆ ~BoostStorage()

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

Destructor.

Definition at line 63 of file BoostStorage.cc.

Member Function Documentation

◆ createInstance()

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

Create and configure a FormatterStorage subclass instance.

Parameters
[in]nameName of subclass
[in]locationLocation to persist to or retrieve from
[in]persistTrue if persisting, false if retrieving
[in]policyPolicy used to configure the FormatterStorage
Returns
Shared pointer to FormatterStorage subclass instance

Definition at line 75 of file FormatterStorage.cc.

◆ endTransaction()

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

End a transaction.

No transaction support for now.

Implements lsst::daf::persistence::FormatterStorage.

Definition at line 104 of file BoostStorage.cc.

◆ getIArchive()

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.

◆ getOArchive()

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.

◆ setPersistLocation()

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

Set the destination of the serialization file for persistence.

Parameters
[in]locationPathname to write to.

Implements lsst::daf::persistence::FormatterStorage.

Definition at line 75 of file BoostStorage.cc.

◆ setPolicy()

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

Definition at line 69 of file BoostStorage.cc.

◆ setRetrieveLocation()

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

Set the source of the serialization file for retrieval.

Parameters
[in]locationPathname to read from.

Implements lsst::daf::persistence::FormatterStorage.

Definition at line 84 of file BoostStorage.cc.

◆ startTransaction()

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

Start a transaction.

No transaction support for now.

Implements lsst::daf::persistence::FormatterStorage.

Definition at line 98 of file BoostStorage.cc.

◆ verifyPathName()

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

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

Parameters
[in]namePathname to file to be created

Definition at line 93 of file FormatterStorage.cc.


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