lsst::daf::persistence::FitsStorage Class Reference

Class for FITS file storage. More...

#include <FitsStorage.h>

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

Public Types
typedef boost::shared_ptr < FitsStorage >	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
	FitsStorage (void)
virtual	~FitsStorage (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 std::string const &	getPath (void)
virtual int	getHdu (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
std::string	_path
int	_hdu

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

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

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.

                             : Storage(typeid(*this)) {
}

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

Definition at line 103 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 116 of file FitsStorage.cc.

                            {
    return _hdu;
}

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

virtual

Return the pathname for the FITS file.

Returns

Pathname

Definition at line 109 of file FitsStorage.cc.

                                          {
    return _path;
}

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

virtual

Set the destination of the FITS file for persistence.

Parameters

[in]

location

Pathname to write to.

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

Definition at line 72 of file FitsStorage.cc.

                                                                    {
    _path = location.locString();
    _hdu = 0;
    verifyPathName(_path);
}

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

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]

location

Pathname to read from, optionally followed by bracketed HDU number.

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

Definition at line 82 of file FitsStorage.cc.

                                                                     {
    _path = location.locString();
    size_t loc = _path.find_last_of('[');
    if (loc == std::string::npos) {
        _hdu = 0;
    }
    else {
        // HDUs for setHdu() are off by one from bracket extensions.
        _hdu = strtol(_path.substr(loc + 1).c_str(), 0, 10) + 1;
    }
}

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

virtual

Start a transaction. No transaction support for now.

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

Definition at line 97 of file FitsStorage.cc.

                                       {
}

Member Data Documentation

int lsst::daf::persistence::FitsStorage::_hdu

private

Definition at line 71 of file FitsStorage.h.

std::string lsst::daf::persistence::FitsStorage::_path

private

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