casacore::FitsKeyword Class Reference

#include <fits.h>

Public Member Functions
	FitsKeyword (const FitsKeyword &)
	A word about friends: FitsKeywordList accesses the next and prev pointers and the FitsKeyword constructors.
FitsKeyword &	operator= (const FitsKeyword &)
	~FitsKeyword ()
const char *	name () const
	get info about the name
int	namelen () const
Bool	isreserved () const
Bool	isindexed () const
const ReservedFitsKeyword &	kw () const
int	index () const
const char *	comm () const
	access the keyword comment
int	commlen () const
int	err () const
	access the error status
FITS::ValueType	type () const
	the datatype of the keyword
Bool	asBool () const
	access the value of the keyword
const char *	asString () const
int	valStrlen () const
Int	asInt () const
float	asFloat () const
double	asDouble () const
IComplex	asIComplex () const
Complex	asComplex () const
DComplex	asDComplex () const
const void *	value () const
FitsKeyword &	operator= (Bool)
	change the value of the keyword
FitsKeyword &	operator= (const char *)
FitsKeyword &	operator= (Int)
FitsKeyword &	operator= (float)
FitsKeyword &	operator= (double)
FitsKeyword &	operator= (IComplex)
FitsKeyword &	operator= (Complex)
FitsKeyword &	operator= (DComplex)
void	comm (const char *)
	change the comment of the keyword
void	name (const char *)
	change the name of the keyword
Private Member Functions
void	del_val ()
void	init (const FitsKeyword &)
void	setval (const FITS::ValueType &, const void *, int)
void	setcomm (const char *, int)
	FitsKeyword (const char , int, FITS::ValueType, const void , int, const char *, int)
	private constructors for use by friends
	FitsKeyword (const ReservedFitsKeyword , int, FITS::ValueType, const void , int, const char *, int)
	constructs reserved keywords parms: resword, index, val, vallen, comm, commlen
Static Private Member Functions
static void	err (const char , const FITS::ValueType &, const void , const char *)
static void	memchk (void *)
Private Attributes
FitsKeyword *	next_
FitsKeyword *	prev_
char *	name_
	the keyword name if name_ is 0, keyword is not a user defined name if ndx is 0, there is no index
const ReservedFitsKeyword *	kw_
int	ndx
short	namelen_
char *	comm_
	the keyword comment if comm_ is 0, there is no comment
short	commlen_
FITS::ValueType	type_
	the keyword value
union {
Bool bval
Int ival
float fval
double dval
};
void *	val
short	vallen
Friends
class	FitsKeywordList
class	FitsParse

Detailed Description

FITS keyword.

Review Status

Reviewed By:: UNKNOWN
Date Reviewed:: before2004/08/25

Synopsis

A FITS keyword contains a name, a value and a comment.

Definition at line 524 of file fits.h.

Constructor & Destructor Documentation

casacore::FitsKeyword::FitsKeyword ( const FitsKeyword & k ) [inline]

A word about friends: FitsKeywordList accesses the next and prev pointers and the FitsKeyword constructors.

FitsParse only accesses the FitsKeyword constructors.

Definition at line 652 of file fits.h.

References init().

casacore::FitsKeyword::~FitsKeyword ( ) [inline]

Definition at line 656 of file fits.h.

References comm_, del_val(), and name_.

casacore::FitsKeyword::FitsKeyword	(	const char *	,
		int	,
		FITS::ValueType	,
		const void *	,
		int	,
		const char *	,
		int
	)			`[private]`

private constructors for use by friends

constructs user-defined keywords parms: name, namelen, type, val, vallen, comm, commlen

casacore::FitsKeyword::FitsKeyword	(	const ReservedFitsKeyword *	,
		int	,
		FITS::ValueType	,
		const void *	,
		int	,
		const char *	,
		int
	)			`[private]`

constructs reserved keywords parms: resword, index, val, vallen, comm, commlen

Member Function Documentation

Bool casacore::FitsKeyword::asBool ( ) const [inline]

access the value of the keyword

Definition at line 678 of file fits.h.

References bval.

Complex casacore::FitsKeyword::asComplex ( ) const [inline]

Definition at line 717 of file fits.h.

References val.

DComplex casacore::FitsKeyword::asDComplex ( ) const [inline]

Definition at line 719 of file fits.h.

References val.

double casacore::FitsKeyword::asDouble ( ) const [inline]

Definition at line 702 of file fits.h.

References casacore::FITS::BYTE, casacore::FITS::DOUBLE, dval, casacore::FITS::FLOAT, fval, ival, casacore::FITS::LONG, casacore::FITS::SHORT, and type().

float casacore::FitsKeyword::asFloat ( ) const [inline]

Definition at line 689 of file fits.h.

References casacore::FITS::BYTE, casacore::FITS::DOUBLE, dval, casacore::FITS::FLOAT, fval, ival, casacore::FITS::LONG, casacore::FITS::SHORT, and type().

IComplex casacore::FitsKeyword::asIComplex ( ) const [inline]

Definition at line 715 of file fits.h.

References val.

Int casacore::FitsKeyword::asInt ( ) const [inline]

Definition at line 682 of file fits.h.

References ival, casacore::FITS::LONG, and type().

const char * casacore::FitsKeyword::asString ( ) const [inline]

Definition at line 679 of file fits.h.

References val, and vallen.

void casacore::FitsKeyword::comm ( const char * )

change the comment of the keyword

const char * casacore::FitsKeyword::comm ( ) const [inline]

access the keyword comment

Definition at line 672 of file fits.h.

References comm_.

int casacore::FitsKeyword::commlen ( ) const [inline]

Definition at line 674 of file fits.h.

References commlen_.

void casacore::FitsKeyword::del_val ( ) [private]

Referenced by operator=(), and ~FitsKeyword().

static void casacore::FitsKeyword::err	(	const char *	,
		const FITS::ValueType &	,
		const void *	,
		const char *
	)			`[static, private]`

int casacore::FitsKeyword::err ( ) const [inline]

access the error status

Definition at line 675 of file fits.h.

References casacore::FITS::ERRWORD, kw(), and name().

int casacore::FitsKeyword::index ( ) const [inline]

Definition at line 670 of file fits.h.

References ndx.

void casacore::FitsKeyword::init ( const FitsKeyword & ) [private]

Referenced by FitsKeyword(), and operator=().

Bool casacore::FitsKeyword::isindexed ( ) const [inline]

Definition at line 669 of file fits.h.

References casacore::False, ndx, and casacore::True.

Bool casacore::FitsKeyword::isreserved ( ) const [inline]

Definition at line 663 of file fits.h.

References casacore::FITS::ERRWORD, casacore::False, kw(), name(), casacore::True, and casacore::FITS::USER_DEF.

Referenced by name().

const ReservedFitsKeyword & casacore::FitsKeyword::kw ( ) const [inline]

Definition at line 662 of file fits.h.

References kw_.

Referenced by err(), isreserved(), and name().

static void casacore::FitsKeyword::memchk ( void * ) [static, private]

void casacore::FitsKeyword::name ( const char * )

change the name of the keyword

const char * casacore::FitsKeyword::name ( ) const [inline]

get info about the name

Definition at line 666 of file fits.h.

References casacore::ReservedFitsKeyword::aname(), isreserved(), kw(), name_, and namelen_.

Referenced by err(), and isreserved().

int casacore::FitsKeyword::namelen ( ) const [inline]

Definition at line 668 of file fits.h.

References namelen_.

FitsKeyword & casacore::FitsKeyword::operator= ( DComplex x ) [inline]

Definition at line 734 of file fits.h.

References casacore::FITS::DCOMPLEX, type_, and val.

FitsKeyword & casacore::FitsKeyword::operator= ( Complex x ) [inline]

Definition at line 732 of file fits.h.

References casacore::FITS::COMPLEX, type_, and val.

FitsKeyword & casacore::FitsKeyword::operator= ( IComplex x ) [inline]

Definition at line 730 of file fits.h.

References casacore::FITS::ICOMPLEX, type_, and val.

FitsKeyword & casacore::FitsKeyword::operator= ( double x ) [inline]

Definition at line 728 of file fits.h.

References casacore::FITS::DOUBLE, dval, and type_.

FitsKeyword & casacore::FitsKeyword::operator= ( float x ) [inline]

Definition at line 726 of file fits.h.

References casacore::FITS::FLOAT, fval, and type_.

FitsKeyword & casacore::FitsKeyword::operator= ( Int x ) [inline]

Definition at line 724 of file fits.h.

References ival, casacore::FITS::LONG, and type_.

FitsKeyword& casacore::FitsKeyword::operator= ( const char * )

FitsKeyword & casacore::FitsKeyword::operator= ( Bool x ) [inline]

change the value of the keyword

Definition at line 722 of file fits.h.

References bval, casacore::FITS::LOGICAL, and type_.

FitsKeyword & casacore::FitsKeyword::operator= ( const FitsKeyword & k ) [inline]

Definition at line 654 of file fits.h.

References comm_, del_val(), init(), and name_.

void casacore::FitsKeyword::setcomm	(	const char *	,
		int
	)			`[private]`

void casacore::FitsKeyword::setval	(	const FITS::ValueType &	,
		const void *	,
		int
	)			`[private]`

FITS::ValueType casacore::FitsKeyword::type ( ) const [inline]

the datatype of the keyword

Definition at line 676 of file fits.h.

References type_.

Referenced by asDouble(), asFloat(), and asInt().

int casacore::FitsKeyword::valStrlen ( ) const [inline]

Definition at line 681 of file fits.h.

References vallen.

const void* casacore::FitsKeyword::value ( ) const

Friends And Related Function Documentation

friend class FitsKeywordList [friend]

Definition at line 525 of file fits.h.

friend class FitsParse [friend]

Definition at line 526 of file fits.h.

Member Data Documentation

union { ... } [private]

Bool casacore::FitsKeyword::bval

Definition at line 617 of file fits.h.

Referenced by asBool(), and operator=().

char* casacore::FitsKeyword::comm_ [private]

the keyword comment if comm_ is 0, there is no comment

Definition at line 608 of file fits.h.

Referenced by comm(), operator=(), and ~FitsKeyword().

short casacore::FitsKeyword::commlen_ [private]

Definition at line 609 of file fits.h.

Referenced by commlen().

double casacore::FitsKeyword::dval

Definition at line 620 of file fits.h.

Referenced by asDouble(), asFloat(), and operator=().

float casacore::FitsKeyword::fval

Definition at line 619 of file fits.h.

Referenced by asDouble(), asFloat(), and operator=().

Int casacore::FitsKeyword::ival

Definition at line 618 of file fits.h.

Referenced by asDouble(), asFloat(), asInt(), and operator=().

const ReservedFitsKeyword* casacore::FitsKeyword::kw_ [private]

Definition at line 600 of file fits.h.

Referenced by kw().

char* casacore::FitsKeyword::name_ [private]

the keyword name if name_ is 0, keyword is not a user defined name if ndx is 0, there is no index

Definition at line 599 of file fits.h.

Referenced by name(), operator=(), and ~FitsKeyword().

short casacore::FitsKeyword::namelen_ [private]

Definition at line 602 of file fits.h.

Referenced by name(), and namelen().

int casacore::FitsKeyword::ndx [private]

Definition at line 601 of file fits.h.

Referenced by index(), and isindexed().

FitsKeyword* casacore::FitsKeyword::next_ [private]

Definition at line 592 of file fits.h.

FitsKeyword* casacore::FitsKeyword::prev_ [private]

Definition at line 593 of file fits.h.

FITS::ValueType casacore::FitsKeyword::type_ [private]

the keyword value

Definition at line 615 of file fits.h.

Referenced by operator=(), and type().

void* casacore::FitsKeyword::val [private]

Definition at line 622 of file fits.h.

Referenced by asComplex(), asDComplex(), asIComplex(), asString(), and operator=().

short casacore::FitsKeyword::vallen [private]

Definition at line 623 of file fits.h.

Referenced by asString(), and valStrlen().

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

casacore/fits/FITS/fits.h

casacore::FitsKeyword Class Reference

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Review Status

Synopsis

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation