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)
 copy constructor
 Keyword (const String &keyname, ValueType keytype, HDU *p, const String &comment="")
 Keyword constructor.
virtual ~Keyword ()
 virtual destructor
Keywordoperator= (const Keyword &right)
 assignment operator
bool operator== (const Keyword &right) const
 equality operator
bool operator!= (const Keyword &right) const
 inequality operator
virtual Keywordclone () const =0
 virtual copy constructor
virtual void write ()=0
 write operation
fitsfile * fitsPointer () const
 return a pointer to the FITS file containing the parent HDU.
const String & comment () const
 return the comment field of the keyword
const String & name () const

Protected Member Functions

ValueType keytype () const
 return the type of a keyword
void keytype (ValueType value)
 set keyword type.
const HDUparent () const
 return a pointer to parent HDU.


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


Member Function Documentation

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

return the name of a keyword


The documentation for this class was generated from the following files:
Generated on Fri Oct 12 13:39:43 2007 for CCfits by  doxygen 1.4.7