GammaLib  2.0.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
GVOTable Class Reference

VOTable class. More...

#include <GVOTable.hpp>

Inheritance diagram for GVOTable:
GBase

Public Member Functions

 GVOTable (void)
 Void constructor. More...
 
 GVOTable (const GFitsTable &table)
 FITS table constructor. More...
 
 GVOTable (const GVOTable &votable)
 Copy constructor. More...
 
virtual ~GVOTable (void)
 Destructor. More...
 
GVOTable & operator= (const GVOTable &votable)
 Assignment operator. More...
 
void clear (void)
 Clear object. More...
 
GVOTable * clone (void) const
 Clone object. More...
 
std::string classname (void) const
 Return class name. More...
 
void read (const GFitsTable &table)
 Read VO table from FITS table. More...
 
const GXml & xml (void) const
 Return VO table XML file. More...
 
const std::string & name (void) const
 Return VO table name. More...
 
std::string print (const GChatter &chatter=NORMAL) const
 Print VO Table information. More...
 
- Public Member Functions inherited from GBase
virtual ~GBase (void)
 Destructor. More...
 

Protected Member Functions

void init_members (void)
 Initialise class members. More...
 
void copy_members (const GVOTable &table)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 
GXmlElement field_from_fits_column (const GFitsTableCol &column) const
 Return FIELD element with column description. More...
 
GXmlElement data_from_fits_table (const GFitsTable &table) const
 Return DATA element with FITS table data. More...
 

Protected Attributes

GXml m_xml
 VO table. More...
 
std::string m_name
 VO table name. More...
 
std::string m_resource
 VO resource name. More...
 
std::string m_description
 VO table description. More...
 

Detailed Description

VOTable class.

This class implements a VOTable for exchanges through VO-compatible applications. The class implements IVOA standard Recommendation 2013-09-20 VOTable1.3.

See http://www.ivoa.net/documents/VOTable/20130920/REC-VOTable-1.3-20130920.pdf

Definition at line 55 of file GVOTable.hpp.

Constructor & Destructor Documentation

GVOTable::GVOTable ( void  )

Void constructor.

Definition at line 55 of file GVOTable.cpp.

References init_members().

Referenced by clone().

GVOTable::GVOTable ( const GFitsTable &  table)
explicit

FITS table constructor.

Parameters
[in]tableFITS table

Definition at line 70 of file GVOTable.cpp.

References init_members(), and read().

GVOTable::GVOTable ( const GVOTable &  votable)

Copy constructor.

Parameters
[in]votableVO table

Definition at line 88 of file GVOTable.cpp.

References copy_members(), and init_members().

GVOTable::~GVOTable ( void  )
virtual

Destructor.

Definition at line 104 of file GVOTable.cpp.

References free_members().

Member Function Documentation

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

Return class name.

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

Implements GBase.

Definition at line 98 of file GVOTable.hpp.

void GVOTable::clear ( void  )
virtual

Clear object.

Reset object to a clean initial state.

Implements GBase.

Definition at line 158 of file GVOTable.cpp.

References free_members(), and init_members().

GVOTable * GVOTable::clone ( void  ) const
virtual

Clone object.

Implements GBase.

Definition at line 174 of file GVOTable.cpp.

References GVOTable().

void GVOTable::copy_members ( const GVOTable &  table)
protected

Copy class members.

Parameters
[in]tableVO table.

Definition at line 273 of file GVOTable.cpp.

References m_description, m_name, m_resource, and m_xml.

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

GXmlElement GVOTable::data_from_fits_table ( const GFitsTable &  table) const
protected

Return DATA element with FITS table data.

Parameters
[in]tableFITS table
Returns
XML DATA element with FITS data

Definition at line 370 of file GVOTable.cpp.

References GXmlNode::append(), GFitsTable::ncols(), and GFitsTable::nrows().

Referenced by read().

GXmlElement GVOTable::field_from_fits_column ( const GFitsTableCol &  column) const
protected

Return FIELD element with column description.

Parameters
[in]columnFITS column
Returns
XML FIELD element with column description

Definition at line 302 of file GVOTable.cpp.

References __TBIT, __TBYTE, __TCOMPLEX, __TDBLCOMPLEX, __TDOUBLE, __TFLOAT, __TINT, __TLOGICAL, __TLONG, __TLONGLONG, __TSBYTE, __TSHORT, __TSTRING, __TUINT, __TULONG, __TUSHORT, GXmlElement::attribute(), GFitsTableCol::colnum(), GFitsTableCol::name(), gammalib::str(), GFitsTableCol::type(), and GFitsTableCol::unit().

Referenced by read().

void GVOTable::free_members ( void  )
protected

Delete class members.

Definition at line 289 of file GVOTable.cpp.

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

void GVOTable::init_members ( void  )
protected

Initialise class members.

Definition at line 255 of file GVOTable.cpp.

References GXml::clear(), m_description, m_name, m_resource, and m_xml.

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

const std::string & GVOTable::name ( void  ) const
inline

Return VO table name.

Returns
VO table name string.

Definition at line 122 of file GVOTable.hpp.

References m_name.

Referenced by GVOClient::publish().

GVOTable & GVOTable::operator= ( const GVOTable &  votable)

Assignment operator.

Parameters
[in]votableVO table.
Returns
VO table.

Definition at line 126 of file GVOTable.cpp.

References copy_members(), free_members(), and init_members().

std::string GVOTable::print ( const GChatter &  chatter = NORMAL) const
virtual

Print VO Table information.

Parameters
[in]chatterChattiness.
Returns
String containing VO table information.

Implements GBase.

Definition at line 227 of file GVOTable.cpp.

References m_xml, GXml::print(), and SILENT.

void GVOTable::read ( const GFitsTable &  table)

Read VO table from FITS table.

Definition at line 184 of file GVOTable.cpp.

References GXmlNode::append(), GXml::append(), GFitsTable::classname(), GXml::clear(), data_from_fits_table(), GFitsHDU::extname(), field_from_fits_column(), m_description, m_name, m_resource, m_xml, and GFitsTable::ncols().

Referenced by GVOTable().

const GXml & GVOTable::xml ( void  ) const
inline

Return VO table XML file.

Returns
VO table XML file.

Definition at line 110 of file GVOTable.hpp.

References m_xml.

Referenced by GVOClient::publish().

Member Data Documentation

std::string GVOTable::m_description
protected

VO table description.

Definition at line 88 of file GVOTable.hpp.

Referenced by copy_members(), init_members(), and read().

std::string GVOTable::m_name
protected

VO table name.

Definition at line 86 of file GVOTable.hpp.

Referenced by copy_members(), init_members(), name(), and read().

std::string GVOTable::m_resource
protected

VO resource name.

Definition at line 87 of file GVOTable.hpp.

Referenced by copy_members(), init_members(), and read().

GXml GVOTable::m_xml
protected

VO table.

Definition at line 85 of file GVOTable.hpp.

Referenced by copy_members(), init_members(), print(), read(), and xml().

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