casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
casa::TBKeyword Class Reference

Representation of a keyword attached to a table or field. More...

#include <TBKeyword.h>

Public Member Functions

 TBKeyword (casacore::String name, TBData &data)
 Constructor which takes the name, type, and value of the keyword. More...
 
 ~TBKeyword ()
 
casacore::String getName ()
 Returns the name of this keyword. More...
 
casacore::String getType ()
 Returns the type of this keyword. More...
 
TBDatagetValue ()
 Returns the value of this keyword. More...
 
casacore::String getDisplayValue ()
 Returns the display value of this keyword. More...
 

Private Attributes

casacore::String name
 Keyword name. More...
 
TBDatadata
 Keyword value. More...
 

Detailed Description

Representation of a keyword attached to a table or field.

Synopsis

A TBKeyword can be attached either to an entire table or to a specific field in a table. Keywords consist of a name, type, and value.

Definition at line 45 of file TBKeyword.h.

Constructor & Destructor Documentation

casa::TBKeyword::TBKeyword ( casacore::String  name,
TBData data 
)

Constructor which takes the name, type, and value of the keyword.

Optionally, a display value can also be entered. (For example, array keywords may not want to display their whole value.) TBKeyword(casacore::String name, casacore::String type, casacore::String value, casacore::String dispValue = "");

casa::TBKeyword::~TBKeyword ( )

Member Function Documentation

casacore::String casa::TBKeyword::getDisplayValue ( )

Returns the display value of this keyword.

If no display value has been defined, the normal value is returned.

casacore::String casa::TBKeyword::getName ( )

Returns the name of this keyword.

casacore::String casa::TBKeyword::getType ( )

Returns the type of this keyword.

TBData* casa::TBKeyword::getValue ( )

Returns the value of this keyword.

Member Data Documentation

TBData* casa::TBKeyword::data
private

Keyword value.

Definition at line 75 of file TBKeyword.h.

casacore::String casa::TBKeyword::name
private

Keyword name.

Definition at line 72 of file TBKeyword.h.


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