casa::TBKeyword Class Reference

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

#include <TBKeyword.h>

List of all members.

Public Member Functions

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

Private Attributes

String name
 Keyword name.
TBDatadata
 Keyword value.

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 ( 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(String name, String type, String value, String dispValue = "");

casa::TBKeyword::~TBKeyword (  ) 

Member Function Documentation

String casa::TBKeyword::getDisplayValue (  ) 

Returns the display value of this keyword.

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

String casa::TBKeyword::getName (  ) 

Returns the name of this keyword.

String casa::TBKeyword::getType (  ) 

Returns the type of this keyword.

TBData* casa::TBKeyword::getValue (  ) 

Returns the value of this keyword.


Member Data Documentation

Keyword value.

Definition at line 75 of file TBKeyword.h.

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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1