lsst.daf.persistence  13.0-31-g48013df+4
Public Types | Public Member Functions | List of all members
lsst::daf::persistence::XmlStorage Class Reference

Class for XML file storage. More...

#include <XmlStorage.h>

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

Public Types

typedef std::shared_ptr< XmlStoragePtr
 
- Public Types inherited from lsst::daf::persistence::FormatterStorage
typedef std::shared_ptr< FormatterStoragePtr
 
typedef std::vector< PtrList
 

Public Member Functions

 XmlStorage (void)
 Constructor. More...
 
virtual ~XmlStorage (void)
 Destructor. More...
 
virtual void setPolicy (lsst::pex::policy::Policy::Ptr policy)
 Allow a Policy to be used to configure the FormatterStorage. More...
 
virtual void setPersistLocation (LogicalLocation const &location)
 Set the destination to persist to. More...
 
virtual void setRetrieveLocation (LogicalLocation const &location)
 Set the source to retrieve from. More...
 
virtual void startTransaction (void)
 Start a transaction. More...
 
virtual void endTransaction (void)
 End a transaction. More...
 
virtual boost::archive::xml_oarchive & getOArchive (void)
 Get a boost::serialization XML archive suitable for output. More...
 
virtual boost::archive::xml_iarchive & getIArchive (void)
 Get a boost::serialization XML archive suitable for input. More...
 
- Public Member Functions inherited from lsst::daf::persistence::FormatterStorage
virtual ~FormatterStorage (void)
 Minimal destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from lsst::daf::persistence::FormatterStorage
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 inherited from lsst::daf::persistence::FormatterStorage
 FormatterStorage (std::type_info const &type)
 Constructor. More...
 
void verifyPathName (std::string const &pathName)
 Ensure that all directories along a path exist, creating them if necessary. More...
 

Detailed Description

Class for XML file storage.

Provides Boost XML archives for Formatter subclasses to use.

Definition at line 58 of file XmlStorage.h.

Member Typedef Documentation

◆ Ptr

Definition at line 60 of file XmlStorage.h.

Constructor & Destructor Documentation

◆ XmlStorage()

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

Constructor.

Definition at line 54 of file XmlStorage.cc.

◆ ~XmlStorage()

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

Destructor.

Clean up streams.

Definition at line 62 of file XmlStorage.cc.

Member Function Documentation

◆ endTransaction()

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

End a transaction.

No transaction support for now, but close streams.

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

Definition at line 97 of file XmlStorage.cc.

◆ getIArchive()

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.

◆ getOArchive()

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.

◆ setPersistLocation()

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

Set the destination to persist to.

Parameters
[in]locationPathname to Boost XML file

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

Definition at line 74 of file XmlStorage.cc.

◆ setPolicy()

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

Allow a Policy to be used to configure the FormatterStorage.

Parameters
[in]policy

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

Definition at line 68 of file XmlStorage.cc.

◆ setRetrieveLocation()

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

Set the source to retrieve from.

Parameters
[in]locationPathname to Boost XML file

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

Definition at line 83 of file XmlStorage.cc.

◆ startTransaction()

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

Start a transaction.

No transaction support for now.

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

Definition at line 91 of file XmlStorage.cc.


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