CCfits::Keyword Class Reference

Abstract base class implementing the common behavior of Keyword objects. More...

#include <Keyword.h>

List of all members.

Public Member Functions

 Keyword (const Keyword &right)
 Keyword (const String &keyname, ValueType keytype, HDU *p, const String &comment="")
virtual ~Keyword ()
Keywordoperator= (const Keyword &right)
bool operator== (const Keyword &right) const
bool operator!= (const Keyword &right) const
virtual Keywordclone () const =0
virtual void write ()=0
fitsfile * fitsPointer () const
const String & comment () const
const String & name () const

Protected Member Functions

ValueType keytype () const
void keytype (ValueType value)
const HDUparent () const


Detailed Description

Abstract base class implementing the common behavior of Keyword objects.

Keywords consists of a name, a value and a comment field. Concrete templated subclasses, KeyData<T>, have a data member that holds the value of keyword.

Typically, the mandatory keywords for a given HDU type are not stored as object of type Keyword, but as intrinsic data types. The Keyword hierarchy is used to store user-supplied information.


Constructor & Destructor Documentation

CCfits::Keyword::Keyword ( const Keyword right  ) 

copy constructor

CCfits::Keyword::Keyword ( const String &  keyname,
ValueType  keytype,
HDU p,
const String &  comment = "" 
)

Keyword constructor.

This is the common behavior of Keywords of any type. Constructor is protected as the class is abstract.

CCfits::Keyword::~Keyword (  )  [virtual]

virtual destructor


Member Function Documentation

Keyword * CCfits::Keyword::clone (  )  const [pure virtual]

virtual copy constructor

const String & CCfits::Keyword::comment (  )  const [inline]

return the comment field of the keyword

fitsfile * CCfits::Keyword::fitsPointer (  )  const

return a pointer to the FITS file containing the parent HDU.

void CCfits::Keyword::keytype ( ValueType  value  )  [inline, protected]

set keyword type.

ValueType CCfits::Keyword::keytype (  )  const [inline, protected]

return the type of a keyword

const String & CCfits::Keyword::name (  )  const [inline]

return the name of a keyword

bool CCfits::Keyword::operator!= ( const Keyword right  )  const

inequality operator

Keyword & CCfits::Keyword::operator= ( const Keyword right  ) 

assignment operator

bool CCfits::Keyword::operator== ( const Keyword right  )  const

equality operator

const HDU * CCfits::Keyword::parent (  )  const [inline, protected]

return a pointer to parent HDU.

void CCfits::Keyword::write (  )  [pure virtual]

write operation


The documentation for this class was generated from the following files:
Generated on Fri Nov 3 17:09:10 2006 for CCfits by  doxygen 1.4.7