casa::TBField Class Reference

Representation of a table field. More...

#include <TBField.h>

Public Member Functions
	TBField (casacore::String name, casacore::String type)
	Constructor to take the name and type. More...
	~TBField ()
casacore::String	getName ()
	Returns this field's name. More...
casacore::String	getType ()
	Returns this field's type. More...
std::vector< TBKeyword * > *	getKeywords ()
	Returns this field's keywords. More...
TBKeyword *	keyword (int i)
	Returns the keyword at index i, or NULL if there is none. More...
TBKeyword *	keyword (casacore::String name)
	Returns the keyword with name i, or NULL if there is none. More...
unsigned int	numKeywords ()
	Returns the number of keywords this field has. More...
TBKeyword *	keywordAt (unsigned int i)
	Returns the keyword at index i. More...
void	addKeyword (TBKeyword *keyword)
	Adds the given keyword to this field's keyword list. More...
void	setUCD (casacore::String ucd)
	Sets this field's UCD property. More...
casacore::String	getUCD ()
	Returns this field's UCD property, or an empty casacore::String if it is not set. More...
void	setRef (casacore::String ref)
	Sets this field's ref property. More...
casacore::String	getRef ()
	Returns this field's ref property, or an empty casacore::String if it is not set. More...
void	setUnit (casacore::String unit)
	Sets this field's unit property. More...
casacore::String	getUnit ()
	Returns this field's unit property, or an empty casacore::String if it is not set. More...
void	setPrecision (casacore::String precision)
	Sets this field's precision property. More...
casacore::String	getPrecision ()
	Returns this field's precision property, or an empty casacore::String if it is not set. More...
void	setWidth (casacore::String width)
	Sets this field's width property. More...
casacore::String	getWidth ()
	Returns this field's width property, or an empty casacore::String if it is not set. More...

Private Attributes
casacore::String	name
	Field name. More...
casacore::String	type
	Field type. More...
std::vector< TBKeyword * >	keywords
	Field keywords. More...
casacore::String	ucd
	Field UCD. More...
casacore::String	ref
	Field ref. More...
casacore::String	unit
	Field unit. More...
casacore::String	precision
	Field precision. More...
casacore::String	width
	Field width. More...

Detailed Description

Representation of a table field.

Synopsis

A TBField consists of a name, a type, a potentially empty list of keywords, and some other potentially empty properties.

Definition at line 48 of file TBField.h.

Constructor & Destructor Documentation

casa::TBField::TBField	(	casacore::String	name,
		casacore::String	type
	)

Constructor to take the name and type.

Other properties must be added via method calls.

casa::TBField::~TBField

(

)

Member Function Documentation

void casa::TBField::addKeyword

(

TBKeyword *

keyword

)

Adds the given keyword to this field's keyword list.

std::vector<TBKeyword*>* casa::TBField::getKeywords

(

)

Returns this field's keywords.

casacore::String casa::TBField::getName

(

)

Returns this field's name.

casacore::String casa::TBField::getPrecision

(

)

Returns this field's precision property, or an empty casacore::String if it is not set.

casacore::String casa::TBField::getRef

(

)

Returns this field's ref property, or an empty casacore::String if it is not set.

casacore::String casa::TBField::getType

(

)

Returns this field's type.

casacore::String casa::TBField::getUCD

(

)

Returns this field's UCD property, or an empty casacore::String if it is not set.

casacore::String casa::TBField::getUnit

(

)

Returns this field's unit property, or an empty casacore::String if it is not set.

casacore::String casa::TBField::getWidth

(

)

Returns this field's width property, or an empty casacore::String if it is not set.

TBKeyword* casa::TBField::keyword

(

int

i

)

Returns the keyword at index i, or NULL if there is none.

TBKeyword* casa::TBField::keyword

(

casacore::String

name

)

Returns the keyword with name i, or NULL if there is none.

TBKeyword* casa::TBField::keywordAt

(

unsigned int

i

)

Returns the keyword at index i.

unsigned int casa::TBField::numKeywords

(

)

Returns the number of keywords this field has.

void casa::TBField::setPrecision

(

casacore::String

precision

)

Sets this field's precision property.

void casa::TBField::setRef

(

casacore::String

ref

)

Sets this field's ref property.

void casa::TBField::setUCD

(

casacore::String

ucd

)

Sets this field's UCD property.

void casa::TBField::setUnit

(

casacore::String

unit

)

Sets this field's unit property.

void casa::TBField::setWidth

(

casacore::String

width

)

Sets this field's width property.

Member Data Documentation

std::vector<TBKeyword*> casa::TBField::keywords

private

Field keywords.

Definition at line 121 of file TBField.h.

casacore::String casa::TBField::name

private

Field name.

Definition at line 115 of file TBField.h.

casacore::String casa::TBField::precision

private

Field precision.

Definition at line 133 of file TBField.h.

casacore::String casa::TBField::ref

private

Field ref.

Definition at line 127 of file TBField.h.

casacore::String casa::TBField::type

private

Field type.

Definition at line 118 of file TBField.h.

casacore::String casa::TBField::ucd

private

Field UCD.

Definition at line 124 of file TBField.h.

casacore::String casa::TBField::unit

private

Field unit.

Definition at line 130 of file TBField.h.

casacore::String casa::TBField::width

private

Field width.

Definition at line 136 of file TBField.h.

---

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

• casa/code/casaqt/QtBrowser/TBField.h