lsst.daf.persistence  13.0-32-g7b14ddd
 All Classes Namespaces Files Functions Variables Typedefs Friends Macros
Public Types | Public Member Functions | List of all members
lsst::daf::persistence::FitsStorage Class Reference

Class for FITS file storage. More...

#include <FitsStorage.h>

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

Public Types

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

Public Member Functions

 FitsStorage (void)
 Constructor. More...
 
virtual ~FitsStorage (void)
 Destructor. More...
 
virtual void setPolicy (lsst::pex::policy::Policy::Ptr policy)
 Allow a Policy to be used to configure the FitsStorage. More...
 
virtual void setPersistLocation (LogicalLocation const &location)
 Set the destination of the FITS file for persistence. More...
 
virtual void setRetrieveLocation (LogicalLocation const &location)
 Set the source of the FITS file for retrieval. More...
 
virtual void startTransaction (void)
 Start a transaction. More...
 
virtual void endTransaction (void)
 End a transaction. More...
 
virtual std::string const & getPath (void)
 Return the pathname for the FITS file. More...
 
virtual int getHdu (void)
 Return the HDU to read from the FITS file. 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 FITS file storage.

Merely maintains pathname and HDU number for Formatter subclasses to use.

Definition at line 52 of file FitsStorage.h.

Member Typedef Documentation

Definition at line 54 of file FitsStorage.h.

Constructor & Destructor Documentation

lsst::daf::persistence::FitsStorage::FitsStorage ( void  )

Constructor.

Definition at line 55 of file FitsStorage.cc.

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

Destructor.

Definition at line 60 of file FitsStorage.cc.

Member Function Documentation

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

End a transaction.

No transaction support for now.

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

Definition at line 102 of file FitsStorage.cc.

int lsst::daf::persistence::FitsStorage::getHdu ( void  )
virtual

Return the HDU to read from the FITS file.

Returns
Number of the HDU, PDU = 0

Definition at line 115 of file FitsStorage.cc.

std::string const & lsst::daf::persistence::FitsStorage::getPath ( void  )
virtual

Return the pathname for the FITS file.

Returns
Pathname

Definition at line 108 of file FitsStorage.cc.

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

Set the destination of the FITS file for persistence.

Parameters
[in]locationPathname to write to.

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

Definition at line 72 of file FitsStorage.cc.

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

Allow a Policy to be used to configure the FitsStorage.

Parameters
[in]policy

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

Definition at line 66 of file FitsStorage.cc.

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

Set the source of the FITS file for retrieval.

Parameters
[in]locationPathname to read from, optionally followed by bracketed HDU number.

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

Definition at line 82 of file FitsStorage.cc.

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

Start a transaction.

No transaction support for now.

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

Definition at line 96 of file FitsStorage.cc.


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