PassiveTableDD.h

Classes

PassiveTableDD -- Class adding Table-specific support functions to PassiveCachingDD. (full description)

class PassiveTableDD : public PassiveCachingDD

Interface

Public Members

PassiveTableDD(Table *table)

PassiveTableDD(const String tablename)

virtual ~PassiveTableDD()

virtual void setDefaultOptions()

virtual Bool setOptions(Record &rec, Record &recOut)

virtual Record getOptions()

virtual AttributeBuffer optionsAsAttributes()

Protected Members

template <class T> Bool getTableKeyword(T &value, const T keyword) const

template <class T> Bool getTableKeyword(T &value, const T &regex) const

template <class T> Bool getColumnKeyword(T &value, const T column, const T keyword) const

template <class T> Bool getColumnKeyword(T &value, const T column, const String &regex) const

Vector<String> getColumnNamesOfType(const DataType type)

Table *table()

PassiveTableDD()

PassiveTableDD(const PassiveTableDD &other)

void operator=(const PassiveTableDD &other)

Private Members

void installDefaultOptions()

Bool arrangeQueryTable()

Description

Synopsis

This class adds support functions useful for dealing with Tables to the PassiveCachingDD class.

Member Description

PassiveTableDD(Table *table)

Constructor taking a pointer to an already constructed Table. The Table will be deleted by this class.

PassiveTableDD(const String tablename)

Constructor taking a String which describes the full pathname of a Table on disk.

virtual void setDefaultOptions()

Install the default options for this DisplayData.

virtual Bool setOptions(Record &rec, Record &recOut)

Apply options stored in rec to the DisplayData. A return value of True means a refresh is needed. recOut contains any fields which were implicitly changed as a result of the call to this function.

virtual Record getOptions()

Retrieve the current and default options and parameter types.

virtual AttributeBuffer optionsAsAttributes()

Return the current options of this DisplayData as an AttributeBuffer.

template <class T> Bool getTableKeyword(T &value, const T keyword) const
template <class T> Bool getTableKeyword(T &value, const T &regex) const

Get the value of the named keyword, or the first keyword matching regex, and return it in value. The return value is True for success, and False for failure, which is the result if the wrong type T is requested.

template <class T> Bool getColumnKeyword(T &value, const T column, const T keyword) const
template <class T> Bool getColumnKeyword(T &value, const T column, const String &regex) const

Get the value of the named keyword, or the first keyword matching regex for the named column, and return it in value. The return value is True for success, and False for failure, which is the result if the wrong type T is requested, or if the keyword doesn't exist.

Vector<String> getColumnNamesOfType(const DataType type)

Get the names of the columns of the table having the given type.

Table *table()

Return the Table pointer for use by derived classes. If a query is active (via setOptions), then the result of the query is returned, otherwise the construction Table is returned.

PassiveTableDD()

(Required) default constructor.

PassiveTableDD(const PassiveTableDD &other)

(Required) copy constructor.

void operator=(const PassiveTableDD &other)

(Required) copy assignment.

void installDefaultOptions()

Install the default options for this DisplayData.

Bool arrangeQueryTable()

Arrange the query table (generally called after installing new options).