GammaLib  1.7.0.dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GFitsAsciiTable Class Reference

FITS ASCII table class. More...

#include <GFitsAsciiTable.hpp>

Inheritance diagram for GFitsAsciiTable:
GFitsTable GFitsHDU GBase

Public Member Functions

 GFitsAsciiTable (void)
 Void constructor. More...
 
 GFitsAsciiTable (const int &nrows)
 Table constructor. More...
 
 GFitsAsciiTable (const GFitsAsciiTable &table)
 Copy constructor. More...
 
virtual ~GFitsAsciiTable (void)
 Destructor. More...
 
GFitsAsciiTableoperator= (const GFitsAsciiTable &table)
 Assignment operator. More...
 
virtual void clear (void)
 Clear ASCII table. More...
 
virtual GFitsAsciiTableclone (void) const
 Clone ASCII table. More...
 
virtual std::string classname (void) const
 Return class name. More...
 
HDUType exttype (void) const
 Return extension type. More...
 
- Public Member Functions inherited from GFitsTable
 GFitsTable (void)
 Void constructor. More...
 
 GFitsTable (const int &nrows)
 Table constructor. More...
 
 GFitsTable (const GFitsTable &table)
 Copy constructor. More...
 
virtual ~GFitsTable (void)
 Destructor. More...
 
GFitsTableoperator= (const GFitsTable &table)
 Assignment operator. More...
 
GFitsTableColoperator[] (const int &colnum)
 Returns pointer to table column. More...
 
const GFitsTableColoperator[] (const int &colnum) const
 Returns pointer to table column (const version) More...
 
GFitsTableColoperator[] (const std::string &colname)
 Returns pointer to table column. More...
 
const GFitsTableColoperator[] (const std::string &colname) const
 Returns pointer to table column (const version) More...
 
GFitsTableColset (const int &colnum, const GFitsTableCol &column)
 Set column. More...
 
GFitsTableColset (const std::string &colname, const GFitsTableCol &column)
 Set column. More...
 
GFitsTableColappend (const GFitsTableCol &column)
 Append column to the table. More...
 
GFitsTableColinsert (int colnum, const GFitsTableCol &column)
 Insert column into the table. More...
 
GFitsTableColinsert (const std::string &colname, const GFitsTableCol &column)
 Insert column into the table. More...
 
void remove (const int &colnum)
 Remove column from the table. More...
 
void remove (const std::string &colname)
 Remove column from the table. More...
 
void append_rows (const int &nrows)
 Append rows to the table. More...
 
void insert_rows (const int &row, const int &nrows)
 Insert rows into the table. More...
 
void remove_rows (const int &row, const int &nrows)
 Remove rows from the table. More...
 
const int & nrows (void) const
 Return number of rows in table. More...
 
const int & ncols (void) const
 Return number of columns in table. More...
 
bool contains (const std::string &colname) const
 Checks the presence of a column in table. More...
 
std::string print (const GChatter &chatter=NORMAL) const
 Print table information. More...
 
- Public Member Functions inherited from GFitsHDU
 GFitsHDU (void)
 Void constructor. More...
 
 GFitsHDU (const GFitsHDU &hdu)
 Copy constructor. More...
 
virtual ~GFitsHDU (void)
 Destructor. More...
 
GFitsHDUoperator= (const GFitsHDU &hdu)
 Assignment operator. More...
 
int cards (void) const
 Return number of cards in HDU header. More...
 
const std::string & extname (void) const
 Return extension name. More...
 
void extname (const std::string &extname)
 Set HDU extension name (EXTNAME keyword) More...
 
const int & extno (void) const
 Return extension number. More...
 
void extno (const int &extno)
 Set extension number. More...
 
const GFitsHeaderheader (void) const
 Return extension header. More...
 
void header (const GFitsHeader &header)
 Set extension header. More...
 
bool has_card (const int &cardno) const
 Check existence of header card. More...
 
bool has_card (const std::string &keyname) const
 Checks for presence of header card. More...
 
GFitsHeaderCardcard (const int &cardno)
 Return header card. More...
 
const GFitsHeaderCardcard (const int &cardno) const
 Return header card (const version) More...
 
GFitsHeaderCardcard (const std::string &keyname)
 Return header card. More...
 
const GFitsHeaderCardcard (const std::string &keyname) const
 Return header card (const version) More...
 
void card (const GFitsHeaderCard &card)
 Append or update header card. More...
 
void card (const std::string &keyname, const std::string &value, const std::string &comment)
 Append or update string value header card. More...
 
void card (const std::string &keyname, const double &value, const std::string &comment)
 Append or update double precision value header card. More...
 
void card (const std::string &keyname, const int &value, const std::string &comment)
 Append or update integer value header card. More...
 
void card (const std::string &keyname, const bool &value, const std::string &comment)
 Append or update boolean value header card. More...
 
void card (const std::string &keyname, const char *value, const std::string &comment)
 Append or update character value header card. More...
 
std::string string (const std::string &keyname) const
 Return card value as string. More...
 
double real (const std::string &keyname) const
 Return card value as double precision. More...
 
int integer (const std::string &keyname) const
 Return card value as integer. More...
 
- Public Member Functions inherited from GBase
virtual ~GBase (void)
 Destructor. More...
 

Private Member Functions

void init_members (void)
 Initialise class members. More...
 
void copy_members (const GFitsAsciiTable &table)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 
void init_table_header (void)
 Initialise ASCII table header. More...
 

Additional Inherited Members

- Public Types inherited from GFitsHDU
enum  HDUType { HT_IMAGE = 0, HT_ASCII_TABLE = 1, HT_BIN_TABLE = 2 }
 
- Protected Member Functions inherited from GFitsTable
void init_members (void)
 Initialise class members. More...
 
void copy_members (const GFitsTable &table)
 Copy class members. More...
 
void free_members (void)
 Free class members. More...
 
void free_columns (void)
 Free column pointers. More...
 
void update_header (void)
 Update header after row or column manipulations. More...
 
void data_open (void *vptr)
 Open Table. More...
 
void data_save (void)
 Save table into FITS file. More...
 
void data_close (void)
 Close table. More...
 
void data_connect (void *vptr)
 Connect table data to FITS file. More...
 
char * get_ttype (const int &colnum) const
 Returns pointer to column type. More...
 
char * get_tform (const int &colnum) const
 Returns pointer to column format. More...
 
char * get_tunit (const int &colnum) const
 Returns pointer to column unit. More...
 
- Protected Member Functions inherited from GFitsHDU
void init_members (void)
 Initialise class members. More...
 
void copy_members (const GFitsHDU &hdu)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 
void connect (void *fptr)
 Connect HDU to FITS file. More...
 
void move_to_hdu (void)
 Move FITS file pointer to HDU. More...
 
HDUType get_hdu_type (void) const
 Get HDU type from FITS file. More...
 
void open (void *vptr, int hdunum)
 Open HDU. More...
 
void save (void)
 Saves HDU. More...
 
std::string print_hdu (const GChatter &chatter=NORMAL) const
 Print basic HDU information. More...
 
std::string typecode (int type) const
 Return typecode as string. More...
 
- Protected Attributes inherited from GFitsTable
int m_type
 Table type (1=ASCII, 2=Binary) More...
 
int m_rows
 Number of rows in table. More...
 
int m_cols
 Number of columns in table. More...
 
GFitsTableCol ** m_columns
 Array of table columns. More...
 
- Protected Attributes inherited from GFitsHDU
void * m_fitsfile
 FITS file pointer pointing on actual HDU. More...
 
int m_hdunum
 HDU number (starting from 0) More...
 
std::string m_name
 HDU name (extname) More...
 
GFitsHeader m_header
 HDU header. More...
 

Detailed Description

FITS ASCII table class.

The following ASCII table columns are supported: TSTRING (A), TLONG (I), TDOUBLE (F,D) TFLOAT (E)

Definition at line 45 of file GFitsAsciiTable.hpp.

Constructor & Destructor Documentation

GFitsAsciiTable::GFitsAsciiTable ( void  )

Void constructor.

Definition at line 49 of file GFitsAsciiTable.cpp.

References init_members().

Referenced by clone().

GFitsAsciiTable::GFitsAsciiTable ( const int &  nrows)
explicit

Table constructor.

Parameters
[in]nrowsNumber of rows in table.

Definition at line 64 of file GFitsAsciiTable.cpp.

References init_members(), and init_table_header().

GFitsAsciiTable::GFitsAsciiTable ( const GFitsAsciiTable table)

Copy constructor.

Parameters
[in]tableASCII table.

Definition at line 82 of file GFitsAsciiTable.cpp.

References copy_members(), and init_members().

GFitsAsciiTable::~GFitsAsciiTable ( void  )
virtual

Destructor.

Definition at line 98 of file GFitsAsciiTable.cpp.

References free_members().

Member Function Documentation

std::string GFitsAsciiTable::classname ( void  ) const
inlinevirtual

Return class name.

Returns
String containing the class name ("GFitsAsciiTable").

Implements GFitsTable.

Definition at line 78 of file GFitsAsciiTable.hpp.

void GFitsAsciiTable::clear ( void  )
virtual

Clear ASCII table.

This method properly resets the object to an initial state.

Implements GFitsTable.

Definition at line 155 of file GFitsAsciiTable.cpp.

References free_members(), GFitsTable::free_members(), GFitsHDU::free_members(), init_members(), GFitsTable::init_members(), and GFitsHDU::init_members().

GFitsAsciiTable * GFitsAsciiTable::clone ( void  ) const
virtual

Clone ASCII table.

Returns
Pointer to deep copy of ASCII table.

Implements GFitsTable.

Definition at line 177 of file GFitsAsciiTable.cpp.

References GFitsAsciiTable().

void GFitsAsciiTable::copy_members ( const GFitsAsciiTable table)
private

Copy class members.

Parameters
tableTable.

Definition at line 207 of file GFitsAsciiTable.cpp.

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

GFitsHDU::HDUType GFitsAsciiTable::exttype ( void  ) const
inlinevirtual

Return extension type.

Returns
Extension type (HT_ASCII_TABLE).

Implements GFitsTable.

Definition at line 90 of file GFitsAsciiTable.hpp.

References GFitsHDU::HT_ASCII_TABLE.

void GFitsAsciiTable::free_members ( void  )
private

Delete class members.

Definition at line 217 of file GFitsAsciiTable.cpp.

Referenced by clear(), operator=(), and ~GFitsAsciiTable().

void GFitsAsciiTable::init_members ( void  )
private

Initialise class members.

Definition at line 192 of file GFitsAsciiTable.cpp.

References GFitsTable::m_type.

Referenced by clear(), GFitsAsciiTable(), and operator=().

void GFitsAsciiTable::init_table_header ( void  )
private

Initialise ASCII table header.

Initialises the table header by setting the default header cards.

Definition at line 231 of file GFitsAsciiTable.cpp.

References GFitsHeader::append(), GFitsTable::m_columns, GFitsHDU::m_header, GFitsTable::ncols(), GFitsTable::nrows(), and GFitsTableCol::width().

Referenced by GFitsAsciiTable().

GFitsAsciiTable & GFitsAsciiTable::operator= ( const GFitsAsciiTable table)

Assignment operator.

Parameters
[in]tableASCII table.
Returns
ASCII table.

Definition at line 120 of file GFitsAsciiTable.cpp.

References copy_members(), free_members(), init_members(), and GFitsTable::operator=().


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