lsst.daf.persistence  16.0-8-gfd407c0+5
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected 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 lsst::daf::base::Citizen

Public Types

typedef std::shared_ptr< FitsStoragePtr
 
typedef std::vector< PtrList
 
typedef unsigned long memId
 
typedef memId(* memNewCallback) (const memId cid)
 
typedef memId(* memCallback) (const Citizen *ptr)
 

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...
 
std::string repr () const
 
void markPersistent (void)
 
memId getId () const
 

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...
 
static bool hasBeenCorrupted ()
 
static memId getNextMemId ()
 
static int init ()
 
static int census (int, memId startingMemId=0)
 
static void census (std::ostream &stream, memId startingMemId=0)
 
static const std::vector< const Citizen *> * census ()
 
static int census (int, memId startingMemId=0)
 
static void census (std::ostream &stream, memId startingMemId=0)
 
static const std::vector< const Citizen *> * census ()
 
static memId setNewCallbackId (memId id)
 
static memId setNewCallbackId (memId id)
 
static memId setDeleteCallbackId (memId id)
 
static memId setDeleteCallbackId (memId id)
 
static memNewCallback setNewCallback (memNewCallback func)
 
static memCallback setDeleteCallback (memCallback func)
 
static memCallback setCorruptionCallback (memCallback func)
 

Public Attributes

 magicSentinel
 

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

◆ List

Definition at line 63 of file FormatterStorage.h.

◆ Ptr

Definition at line 54 of file FitsStorage.h.

Constructor & Destructor Documentation

◆ FitsStorage()

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

Constructor.

Definition at line 55 of file FitsStorage.cc.

◆ ~FitsStorage()

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

Destructor.

Definition at line 60 of file FitsStorage.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::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.

◆ getHdu()

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.

◆ getPath()

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.

◆ setPersistLocation()

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.

◆ setPolicy()

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.

◆ setRetrieveLocation()

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.

◆ startTransaction()

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.

◆ 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: