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

FITS table Boolean column. More...

#include <GFitsTableBoolCol.hpp>

Inheritance diagram for GFitsTableBoolCol:
GFitsTableCol GBase

Public Member Functions

 GFitsTableBoolCol (void)
 Constructor. More...
 
 GFitsTableBoolCol (const std::string &name, const int &nrows, const int &size=1)
 Constructor. More...
 
 GFitsTableBoolCol (const GFitsTableBoolCol &column)
 Copy constructor. More...
 
virtual ~GFitsTableBoolCol (void)
 Destructor. More...
 
GFitsTableBoolColoperator= (const GFitsTableBoolCol &column)
 Assignment operator. More...
 
bool & operator() (const int &row, const int &inx=0)
 Column data access operator. More...
 
const bool & operator() (const int &row, const int &inx=0) const
 Column data access operator (const variant) More...
 
virtual void clear (void)
 Clear instance. More...
 
virtual GFitsTableBoolColclone (void) const
 Clone column. More...
 
virtual std::string classname (void) const
 Return class name. More...
 
virtual std::string string (const int &row, const int &col=0) const
 Get string value. More...
 
virtual double real (const int &row, const int &col=0) const
 Get double precision value. More...
 
virtual int integer (const int &row, const int &col=0) const
 Get integer value. More...
 
virtual void insert (const int &row, const int &nrows)
 Insert rows in column. More...
 
virtual void remove (const int &row, const int &nrows)
 Remove rows from column. More...
 
virtual bool is_loaded (void) const
 Checks if column has been loaded. More...
 
bool * data (void)
 Returns pointer to column data. More...
 
bool * nulval (void)
 Returns pointer to nul value. More...
 
void nulval (const bool *value)
 Set nul value. More...
 
- Public Member Functions inherited from GFitsTableCol
 GFitsTableCol (void)
 Void constructor. More...
 
 GFitsTableCol (const std::string &name, const int &nrows, const int &number, const int &width)
 Column constructor. More...
 
 GFitsTableCol (const GFitsTableCol &column)
 Copy constructor. More...
 
virtual ~GFitsTableCol (void)
 Destructor. More...
 
GFitsTableColoperator= (const GFitsTableCol &column)
 Assignment operator. More...
 
void name (const std::string &name)
 Set column name. More...
 
const std::string & name (void) const
 Returns column name. More...
 
void unit (const std::string &unit)
 Set column unit. More...
 
const std::string & unit (void) const
 Returns column unit. More...
 
void dim (const std::vector< int > &dim)
 Set column dimension. More...
 
const std::vector< int > & dim (void) const
 Returns column dimension. More...
 
void colnum (const int &colnum)
 Set column number. More...
 
const int & colnum (void) const
 Returns column number in FITS file (starting from 1) More...
 
void type (const int &type)
 Set type code. More...
 
const int & type (void) const
 Returns CFITSIO column type. More...
 
void repeat (const int &repeat)
 Set repeat value. More...
 
const int & repeat (void) const
 Returns column repeat value (only used for binary tables) More...
 
void width (const int &width)
 Set width in Bytes of one column element. More...
 
const int & width (void) const
 Return width in Bytes of one column element. More...
 
void number (const int &number)
 Set number of elements in column. More...
 
const int & number (void) const
 Returns number of elements in column. More...
 
void elements (const int &row, const int &elements)
 Set number of column elements for specific row. More...
 
int elements (const int &row) const
 Returns number of elements in column for specific row. More...
 
void nrows (const int &nrows)
 Set number of rows in column. More...
 
const int & nrows (void) const
 Returns number of rows in column. More...
 
void is_variable (const bool &variable)
 Set variable-length flag. More...
 
const bool & is_variable (void) const
 Signals if column is of variable length. More...
 
void anynul (const int &anynul)
 Set number of NULLs encountered. More...
 
const int & anynul (void) const
 Returns number of NULLs encountered. More...
 
void scale (const double &tscale, const double &tzero) const
 Set table column scale value. More...
 
std::string tform_binary (void) const
 Returns TFORM code for binary table column. More...
 
std::string print (const GChatter &chatter=NORMAL) const
 Print column information. 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 GFitsTableBoolCol &column)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 
void alloc_nulval (const bool *value)
 Allocate null value. More...
 
void alloc_buffer (void) const
 Allocate CFITSIO transfer buffer. More...
 
void free_buffer (void) const
 Free CFITSIO transfer buffer. More...
 
virtual void alloc_data (void)
 Allocates column data. More...
 
virtual void init_data (void)
 Initialise column data. More...
 
virtual void fetch_data (void) const
 Fetch column data. More...
 
virtual void resize_data (const int &index, const int &number)
 Resize column data. More...
 
virtual void release_data (void)
 Release column data. More...
 
virtual void * ptr_data (const int &index=0)
 Returns void pointer to column data. More...
 
virtual void * ptr_nulval (void)
 Returns void pointer to nul value. More...
 
virtual std::string ascii_format (void) const
 Returns format string of ASCII table. More...
 
virtual void save (void)
 Save table column into FITS file. More...
 

Private Attributes

bool * m_data
 Data area. More...
 
bool * m_nulval
 NULL value. More...
 
char * m_buffer
 Data area for CFITSIO transfer. More...
 

Additional Inherited Members

- Protected Member Functions inherited from GFitsTableCol
void init_members (void)
 Initialise class members. More...
 
void copy_members (const GFitsTableCol &column)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 
void connect (void *vptr)
 Connect table column to FITS file. More...
 
virtual void load_column (void)
 Load table column from FITS file. More...
 
virtual void load_column_fixed (void)
 Load fixed-length column from FITS file. More...
 
virtual void load_column_variable (void)
 Load variable-length column from FITS file. More...
 
virtual void save_column (void)
 Save table column into FITS file. More...
 
virtual void save_column_fixed (void)
 Save table column into FITS file. More...
 
virtual void save_column_variable (void)
 Save table column into FITS file. More...
 
virtual int offset (const int &row, const int &inx) const
 Compute offset of column element in memory. More...
 
- Protected Attributes inherited from GFitsTableCol
std::string m_name
 Column name. More...
 
std::string m_unit
 Column unit. More...
 
std::vector< int > m_dim
 Column dimension. More...
 
int m_colnum
 Column number (starting from 1). This parameter is used to signal if a table column corresponds to a FITS file column. If it is set to 0 there is no correspondence. More...
 
int m_type
 Column type. More...
 
int m_repeat
 Repeat value of column. More...
 
int m_width
 Width in Bytes of single column element. More...
 
int m_number
 Number of elements in column. More...
 
int m_length
 Length of column (number of rows) More...
 
bool m_variable
 Signals if column is variable length. More...
 
int m_varlen
 Maximum number of elements in variable-length. More...
 
std::vector< int > m_rowstart
 Start index of each row. More...
 
int m_size
 Size of allocated data area (0 if not loaded) More...
 
int m_anynul
 Number of NULLs encountered. More...
 
void * m_fitsfile
 FITS file pointer associated with column. More...
 

Detailed Description

FITS table Boolean column.

This class implements a FITS table Boolean column.

Todo:
Each Bit is actually stored in one Byte. To save memory a more compact storage scheme should be implemented.

Definition at line 45 of file GFitsTableBoolCol.hpp.

Constructor & Destructor Documentation

GFitsTableBoolCol::GFitsTableBoolCol ( void  )

Constructor.

Definition at line 57 of file GFitsTableBoolCol.cpp.

References init_members().

Referenced by clone().

GFitsTableBoolCol::GFitsTableBoolCol ( const std::string &  name,
const int &  nrows,
const int &  size = 1 
)

Constructor.

Parameters
[in]nameName of column.
[in]nrowsNumber of rows in column.
[in]sizeVector size of column.

Definition at line 74 of file GFitsTableBoolCol.cpp.

References init_members().

GFitsTableBoolCol::GFitsTableBoolCol ( const GFitsTableBoolCol column)

Copy constructor.

Parameters
[in]columnTable column.

Definition at line 92 of file GFitsTableBoolCol.cpp.

References copy_members(), and init_members().

GFitsTableBoolCol::~GFitsTableBoolCol ( void  )
virtual

Destructor.

Definition at line 109 of file GFitsTableBoolCol.cpp.

References free_members().

Member Function Documentation

void GFitsTableBoolCol::alloc_buffer ( void  ) const
private

Allocate CFITSIO transfer buffer.

The CFITSIO transfer buffer allows transparent conversion from the CFITSIO storage format to a vector of bool values.

Definition at line 816 of file GFitsTableBoolCol.cpp.

References m_buffer, and GFitsTableCol::m_size.

Referenced by alloc_data(), and save().

void GFitsTableBoolCol::alloc_data ( void  )
privatevirtual

Allocates column data.

Implements GFitsTableCol.

Definition at line 638 of file GFitsTableBoolCol.cpp.

References alloc_buffer(), free_buffer(), m_data, and GFitsTableCol::m_size.

Referenced by insert().

void GFitsTableBoolCol::alloc_nulval ( const bool *  value)
private

Allocate null value.

Definition at line 774 of file GFitsTableBoolCol.cpp.

References m_nulval.

Referenced by copy_members(), and nulval().

std::string GFitsTableBoolCol::ascii_format ( void  ) const
privatevirtual

Returns format string of ASCII table.

Implements GFitsTableCol.

Definition at line 619 of file GFitsTableBoolCol.cpp.

References GFitsTableCol::m_width, and gammalib::str().

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

Return class name.

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

Implements GFitsTableCol.

Definition at line 111 of file GFitsTableBoolCol.hpp.

void GFitsTableBoolCol::clear ( void  )
virtual

Clear instance.

This method properly resets the object to an initial state.

Implements GFitsTableCol.

Definition at line 202 of file GFitsTableBoolCol.cpp.

References free_members(), GFitsTableCol::free_members(), init_members(), and GFitsTableCol::init_members().

GFitsTableBoolCol * GFitsTableBoolCol::clone ( void  ) const
virtual

Clone column.

Implements GFitsTableCol.

Definition at line 220 of file GFitsTableBoolCol.cpp.

References GFitsTableBoolCol().

void GFitsTableBoolCol::copy_members ( const GFitsTableBoolCol column)
private

Copy class members.

Parameters
[in]columnColumn.

Sets the content of the vector column by copying from another column. If the code is compiled with the small memory option, and if the source column has not yet been loaded, then we only load the column temporarily for copying purposes and release it again once copying is finished.

Definition at line 521 of file GFitsTableBoolCol.cpp.

References alloc_nulval(), fetch_data(), is_loaded(), m_data, m_nulval, GFitsTableCol::m_rowstart, GFitsTableCol::m_size, GFitsTableCol::m_type, GFitsTableCol::m_varlen, and release_data().

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

bool * GFitsTableBoolCol::data ( void  )
inline

Returns pointer to column data.

Returns
Pointer to column data.

Definition at line 135 of file GFitsTableBoolCol.hpp.

References m_data.

void GFitsTableBoolCol::fetch_data ( void  ) const
privatevirtual

Fetch column data.

If a FITS file is attached to the column the data are loaded into memory from the FITS file. If no FITS file is attached, memory is allocated to hold the column data and all cells are set to 0.

Refer to GFitsTableCol::load_column for more information.

Implements GFitsTableCol.

Definition at line 669 of file GFitsTableBoolCol.cpp.

References free_buffer(), GFitsTableCol::load_column(), m_buffer, m_data, and GFitsTableCol::m_size.

Referenced by copy_members(), insert(), integer(), operator()(), real(), remove(), resize_data(), and string().

void GFitsTableBoolCol::free_buffer ( void  ) const
private

Free CFITSIO transfer buffer.

Release memory that has been allocated for the CFITSIO transfer buffer.

Definition at line 836 of file GFitsTableBoolCol.cpp.

References m_buffer.

Referenced by alloc_data(), fetch_data(), free_members(), and save().

void GFitsTableBoolCol::free_members ( void  )
private

Delete class members.

Definition at line 562 of file GFitsTableBoolCol.cpp.

References free_buffer(), m_data, m_nulval, and GFitsTableCol::m_size.

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

void GFitsTableBoolCol::init_data ( void  )
privatevirtual

Initialise column data.

Implements GFitsTableCol.

Definition at line 796 of file GFitsTableBoolCol.cpp.

References m_data, and GFitsTableCol::m_size.

Referenced by insert().

void GFitsTableBoolCol::init_members ( void  )
private

Initialise class members.

Definition at line 498 of file GFitsTableBoolCol.cpp.

References __TLOGICAL, m_buffer, m_data, m_nulval, and GFitsTableCol::m_type.

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

void GFitsTableBoolCol::insert ( const int &  row,
const int &  nrows 
)
virtual

Insert rows in column.

Parameters
[in]rowRow after which rows should be inserted (0=first row).
[in]nrowsNumber of rows to be inserted.
Exceptions
GException::fits_invalid_rowSpecified row is invalid.

Inserts rows into a FITS table. This implies that the column will be loaded into memory.

Implements GFitsTableCol.

Definition at line 301 of file GFitsTableBoolCol.cpp.

References alloc_data(), fetch_data(), G_INSERT, init_data(), m_data, GFitsTableCol::m_length, GFitsTableCol::m_number, GFitsTableCol::m_size, and GFitsTableCol::nrows().

int GFitsTableBoolCol::integer ( const int &  row,
const int &  inx = 0 
) const
virtual

Get integer value.

Parameters
[in]rowTable row.
[in]inxTable column vector index.

Returns value of specified row and vector index as integer.

Implements GFitsTableCol.

Definition at line 276 of file GFitsTableBoolCol.cpp.

References fetch_data(), m_data, and GFitsTableCol::offset().

bool GFitsTableBoolCol::is_loaded ( void  ) const
inlinevirtual

Checks if column has been loaded.

Returns
True if column has been loaded, false otherwise

Implements GFitsTableCol.

Definition at line 123 of file GFitsTableBoolCol.hpp.

References m_data.

Referenced by copy_members().

bool * GFitsTableBoolCol::nulval ( void  )
inline

Returns pointer to nul value.

Returns
Pointer to nul value.

Definition at line 147 of file GFitsTableBoolCol.hpp.

References m_nulval.

void GFitsTableBoolCol::nulval ( const bool *  value)

Set nul value.

Parameters
[in]valueNul value.
Todo:
To correctly reflect the nul value in the data, the column should be reloaded. However, the column may have been changed, so in principle saving is needed. However, we may not want to store the data, hence saving is also not desired. We thus have to develop a method to update the column information for a new nul value in place ...

Definition at line 473 of file GFitsTableBoolCol.cpp.

References alloc_nulval().

bool & GFitsTableBoolCol::operator() ( const int &  row,
const int &  inx = 0 
)

Column data access operator.

Parameters
[in]rowRow of column to access.
[in]inxVector index in column row to access.

Provides access to data in a column.

Definition at line 163 of file GFitsTableBoolCol.cpp.

References fetch_data(), m_data, and GFitsTableCol::offset().

const bool & GFitsTableBoolCol::operator() ( const int &  row,
const int &  inx = 0 
) const

Column data access operator (const variant)

Parameters
[in]rowRow of column to access.
[in]inxVector index in column row to access

Provides access to data in a column.

Definition at line 181 of file GFitsTableBoolCol.cpp.

References fetch_data(), m_data, and GFitsTableCol::offset().

GFitsTableBoolCol & GFitsTableBoolCol::operator= ( const GFitsTableBoolCol column)

Assignment operator.

Parameters
[in]columnTable column.
Returns
Table column.

Definition at line 131 of file GFitsTableBoolCol.cpp.

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

void * GFitsTableBoolCol::ptr_data ( const int &  index = 0)
inlineprivatevirtual

Returns void pointer to column data.

Returns
Void pointer to column data.

Implements GFitsTableCol.

Definition at line 159 of file GFitsTableBoolCol.hpp.

References m_buffer.

void * GFitsTableBoolCol::ptr_nulval ( void  )
inlineprivatevirtual

Returns void pointer to nul value.

Returns
Void pointer to nul value.

Implements GFitsTableCol.

Definition at line 171 of file GFitsTableBoolCol.hpp.

References m_nulval.

double GFitsTableBoolCol::real ( const int &  row,
const int &  inx = 0 
) const
virtual

Get double precision value.

Parameters
[in]rowTable row.
[in]inxTable column vector index.

Returns value of specified row and vector index as double precision.

Implements GFitsTableCol.

Definition at line 255 of file GFitsTableBoolCol.cpp.

References fetch_data(), m_data, and GFitsTableCol::offset().

void GFitsTableBoolCol::release_data ( void  )
privatevirtual

Release column data.

Implements GFitsTableCol.

Definition at line 757 of file GFitsTableBoolCol.cpp.

References m_data, and GFitsTableCol::m_size.

Referenced by copy_members(), and resize_data().

void GFitsTableBoolCol::remove ( const int &  row,
const int &  nrows 
)
virtual

Remove rows from column.

Parameters
[in]rowRow after which rows should be removed (0=first row).
[in]nrowsNumber of rows to be removed.
Exceptions
GException::fits_invalid_rowSpecified row is invalid.
GException::fits_invalid_nrowsInvalid number of rows specified.

This method removes rows from a FITS table. This implies that the column will be loaded into memory.

Implements GFitsTableCol.

Definition at line 386 of file GFitsTableBoolCol.cpp.

References fetch_data(), G_REMOVE, m_data, GFitsTableCol::m_length, GFitsTableCol::m_number, GFitsTableCol::m_size, and GFitsTableCol::nrows().

void GFitsTableBoolCol::resize_data ( const int &  index,
const int &  number 
)
privatevirtual

Resize column data.

Parameters
[in]indexStart index.
[in]numberNumber of elements to add/remove.

Adds or removes elements from specified index on. Adding is done if number is a positive number, removing if number is negative. Note that the method does not change the validity of the arguments. This needs to be done by the client.

Implements GFitsTableCol.

Definition at line 698 of file GFitsTableBoolCol.cpp.

References fetch_data(), gammalib::left(), m_data, GFitsTableCol::m_size, GFitsTableCol::number(), and release_data().

void GFitsTableBoolCol::save ( void  )
privatevirtual

Save table column into FITS file.

The table column is only saved if it is linked to a FITS file and if the data are indeed present in the class instance. This avoids saving of data that have not been modified.

Refer to GFitsTableCol::save_column() for more information.

Reimplemented from GFitsTableCol.

Definition at line 592 of file GFitsTableBoolCol.cpp.

References alloc_buffer(), free_buffer(), m_buffer, m_data, GFitsTableCol::m_size, and GFitsTableCol::save_column().

std::string GFitsTableBoolCol::string ( const int &  row,
const int &  inx = 0 
) const
virtual

Get string value.

Parameters
[in]rowTable row.
[in]inxTable column vector index.

Returns value of specified row and vector index as string.

Implements GFitsTableCol.

Definition at line 234 of file GFitsTableBoolCol.cpp.

References fetch_data(), m_data, and GFitsTableCol::offset().

Member Data Documentation

char* GFitsTableBoolCol::m_buffer
mutableprivate

Data area for CFITSIO transfer.

Definition at line 101 of file GFitsTableBoolCol.hpp.

Referenced by alloc_buffer(), fetch_data(), free_buffer(), init_members(), ptr_data(), and save().

bool* GFitsTableBoolCol::m_data
private
bool* GFitsTableBoolCol::m_nulval
private

NULL value.

Definition at line 100 of file GFitsTableBoolCol.hpp.

Referenced by alloc_nulval(), copy_members(), free_members(), init_members(), nulval(), and ptr_nulval().


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