casa::PrimaryGroup< TYPE > Class Template Reference

Random Group datastructure. More...

#include <hdu.h>

Inheritance diagram for casa::PrimaryGroup< TYPE >:

List of all members.

Public Member Functions
	PrimaryGroup (FitsInput &, FITSErrorHandler errhandler=FITSError::defaultHandler)
	PrimaryGroup (FitsKeywordList &, FITSErrorHandler errhandler=FITSError::defaultHandler)
	PrimaryGroup (FITSErrorHandler errhandler=FITSError::defaultHandler)
	constructor for header consisted required keywords only
	~PrimaryGroup ()
Int	gcount () const
	Return basic parameters of a random group.
Int	pcount () const
char *	ptype (int n) const
double	pscal (int n) const
double	pzero (int n) const
Int	currgroup () const
double	parm (int)
TYPE &	rawparm (int)
void	storeparm (const TYPE *source)
void	copyparm (double *target) const
void	copyparm (float *target) const
void	moveparm (TYPE *target) const
int	read ()
	read, or write the next group
int	write (FitsOutput &)
int	write_priGrp_hdr (FitsOutput &fout, int simple, int bitpix, int naxis, long naxes[], long pcount, long gcount)
	write the required keywords for PrimaryGroup
OFF_T	set_next (OFF_T)
	disable these functions, since they are inherited from PrimaryArray
int	read (int)
Protected Attributes
Int	pcount_x
Int	gcount_x
char **	ptype_x
double *	pscal_x
double *	pzero_x
TYPE *	group_parm
Int	current_group
Private Member Functions
void	pg_assign ()

---

Detailed Description

template<class TYPE>
class casa::PrimaryGroup< TYPE >

Random Group datastructure.

Synopsis

A Random Group Structure is represented by the following:

        struct GroupData {
                <Type> group_parms [PCOUNT];
                <Type> data_array [NAXIS2][NAXIS3]...[NAXISN];
        } group_data[GCOUNT];

Template Type Argument Requirements

• typedef PrimaryGroup<unsigned char> BytePrimaryGroup;
• typedef PrimaryGroup<short> ShortPrimaryGroup;
• typedef PrimaryGroup<FitsLong> LongPrimaryGroup;
• typedef PrimaryGroup<float> FloatPrimaryGroup;
• typedef PrimaryGroup<double> DoublePrimaryGroup;

Warning: Please note that the NOST has deprecated the Random Group datastructure, it has been replaced by the much more powerfull BINTABLE extension;

Definition at line 594 of file hdu.h.

---

Constructor & Destructor Documentation

template<class TYPE>

casa::PrimaryGroup< TYPE >::PrimaryGroup	(	FitsInput &	,
		FITSErrorHandler	errhandler = FITSError::defaultHandler
	)

template<class TYPE>

casa::PrimaryGroup< TYPE >::PrimaryGroup	(	FitsKeywordList &	,
		FITSErrorHandler	errhandler = FITSError::defaultHandler
	)

template<class TYPE>

casa::PrimaryGroup< TYPE >::PrimaryGroup

(

FITSErrorHandler

errhandler = FITSError::defaultHandler

)

constructor for header consisted required keywords only

template<class TYPE>

casa::PrimaryGroup< TYPE >::~PrimaryGroup

(

)

---

Member Function Documentation

template<class TYPE>

void casa::PrimaryGroup< TYPE >::copyparm

(

double *

target

)

const

template<class TYPE>

void casa::PrimaryGroup< TYPE >::copyparm

(

float *

target

)

const

template<class TYPE>

Int casa::PrimaryGroup< TYPE >::currgroup

(

)

const [inline]

Definition at line 614 of file hdu.h.

template<class TYPE>

Int casa::PrimaryGroup< TYPE >::gcount

(

)

const [inline]

Return basic parameters of a random group.

Definition at line 607 of file hdu.h.

Referenced by casa::MSPrimaryGroupHolder::gcount().

template<class TYPE>

void casa::PrimaryGroup< TYPE >::moveparm

(

TYPE *

target

)

const

template<class TYPE>

double casa::PrimaryGroup< TYPE >::parm

(

int

)

Referenced by casa::MSPrimaryGroupHolder::parm().

template<class TYPE>

Int casa::PrimaryGroup< TYPE >::pcount

(

)

const [inline]

Definition at line 608 of file hdu.h.

Referenced by casa::MSPrimaryGroupHolder::pcount().

template<class TYPE>

void casa::PrimaryGroup< TYPE >::pg_assign

(

)

[private]

template<class TYPE>

double casa::PrimaryGroup< TYPE >::pscal

(

int

n

)

const [inline]

Definition at line 610 of file hdu.h.

template<class TYPE>

char* casa::PrimaryGroup< TYPE >::ptype

(

int

n

)

const [inline]

Definition at line 609 of file hdu.h.

Referenced by casa::MSPrimaryGroupHolder::ptype().

template<class TYPE>

double casa::PrimaryGroup< TYPE >::pzero

(

int

n

)

const [inline]

Definition at line 611 of file hdu.h.

template<class TYPE>

TYPE& casa::PrimaryGroup< TYPE >::rawparm

(

int

)

template<class TYPE>

int casa::PrimaryGroup< TYPE >::read

(

)

[virtual]

read, or write the next group

Reimplemented from casa::PrimaryArray< TYPE >.

Referenced by casa::MSPrimaryGroupHolder::read().

template<class TYPE>

int casa::PrimaryGroup< TYPE >::read

(

int

)

[inline, virtual]

Reimplemented from casa::PrimaryArray< TYPE >.

Definition at line 639 of file hdu.h.

template<class TYPE>

OFF_T casa::PrimaryGroup< TYPE >::set_next

(

OFF_T

)

[inline, virtual]

disable these functions, since they are inherited from PrimaryArray

Reimplemented from casa::PrimaryArray< TYPE >.

Definition at line 638 of file hdu.h.

template<class TYPE>

void casa::PrimaryGroup< TYPE >::storeparm

(

const TYPE *

source

)

template<class TYPE>

int casa::PrimaryGroup< TYPE >::write

(

FitsOutput &

)

[virtual]

Reimplemented from casa::PrimaryArray< TYPE >.

template<class TYPE>

int casa::PrimaryGroup< TYPE >::write_priGrp_hdr	(	FitsOutput &	fout,
		int	simple,
		int	bitpix,
		int	naxis,
		long	naxes[],
		long	pcount,
		long	gcount
	)

write the required keywords for PrimaryGroup

---

Member Data Documentation

template<class TYPE>

Int casa::PrimaryGroup< TYPE >::current_group [protected]

Definition at line 649 of file hdu.h.

Referenced by casa::PrimaryGroup< Short >::currgroup().

template<class TYPE>

Int casa::PrimaryGroup< TYPE >::gcount_x [protected]

Definition at line 644 of file hdu.h.

Referenced by casa::PrimaryGroup< Short >::gcount().

template<class TYPE>

TYPE* casa::PrimaryGroup< TYPE >::group_parm [protected]

Definition at line 648 of file hdu.h.

template<class TYPE>

Int casa::PrimaryGroup< TYPE >::pcount_x [protected]

Definition at line 643 of file hdu.h.

Referenced by casa::PrimaryGroup< Short >::pcount().

template<class TYPE>

double* casa::PrimaryGroup< TYPE >::pscal_x [protected]

Definition at line 646 of file hdu.h.

Referenced by casa::PrimaryGroup< Short >::pscal().

template<class TYPE>

char** casa::PrimaryGroup< TYPE >::ptype_x [protected]

Definition at line 645 of file hdu.h.

Referenced by casa::PrimaryGroup< Short >::ptype().

template<class TYPE>

double* casa::PrimaryGroup< TYPE >::pzero_x [protected]

Definition at line 647 of file hdu.h.

Referenced by casa::PrimaryGroup< Short >::pzero().

---

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

• casacore/fits/FITS/hdu.h