casa::PassiveTableDD Class Reference

Class adding Table-specific support functions to PassiveCachingDD. More...

#include <PassiveTableDD.h>

Inheritance diagram for casa::PassiveTableDD:

Public Member Functions
	PassiveTableDD (Table *table)
	Constructor taking a pointer to an already constructed Table.
	PassiveTableDD (const String tablename)
	Constructor taking a String which describes the full pathname of a Table on disk.
virtual	~PassiveTableDD ()
	Destructor.
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.
virtual Record	getOptions (bool scrub=false) const
	Retrieve the current and default options and parameter types.
virtual AttributeBuffer	optionsAsAttributes ()
	Return the current options of this DisplayData as an AttributeBuffer.
Protected Member Functions
template<class T >
Bool	getTableKeyword (T &value, const String keyword) const
	Get the value of the named keyword, or the first keyword matching `regex`, and return it in `value`.
template<class T >
Bool	getTableKeyword (T &value, const Regex &regex) const
template<class T >
Bool	getColumnKeyword (T &value, const String column, const String keyword) const
	Get the value of the named keyword, or the first keyword matching `regex` for the named column, and return it in `value`.
template<class T >
Bool	getColumnKeyword (T &value, const String column, const Regex &regex) const
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.
	PassiveTableDD ()
	(Required) default constructor.
	PassiveTableDD (const PassiveTableDD &other)
	(Required) copy constructor.
void	operator= (const PassiveTableDD &other)
	(Required) copy assignment.
Private Member Functions
void	installDefaultOptions ()
	Install the default options for this DisplayData.
Bool	arrangeQueryTable ()
	Arrange the query table (generally called after installing new options).
Private Attributes
Table *	itsTable
	Store the primary table here.
Table *	itsQueryTable
	Store the result of a query on the table here.
String	itsOptQueryString
	Option: what is the query string, or is it unset?
Bool	itsOptQueryStringUnset

Detailed Description

Class adding Table-specific support functions to PassiveCachingDD.

Synopsis

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

Definition at line 51 of file PassiveTableDD.h.

Constructor & Destructor Documentation

casa::PassiveTableDD::PassiveTableDD ( Table * table )

Constructor taking a pointer to an already constructed Table.

The Table will be deleted by this class.

casa::PassiveTableDD::PassiveTableDD ( const String tablename )

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

virtual casa::PassiveTableDD::~PassiveTableDD ( ) [virtual]

Destructor.

casa::PassiveTableDD::PassiveTableDD ( ) [protected]

(Required) default constructor.

casa::PassiveTableDD::PassiveTableDD ( const PassiveTableDD & other ) [protected]

(Required) copy constructor.

Member Function Documentation

Bool casa::PassiveTableDD::arrangeQueryTable ( ) [private]

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

template<class T >

Bool casa::PassiveTableDD::getColumnKeyword	(	T &	value,
		const String	column,
		const Regex &	regex
	)			const `[inline, protected]`

template<class T >

Bool casa::PassiveTableDD::getColumnKeyword	(	T &	value,
		const String	column,
		const String	keyword
	)			const `[inline, protected]`

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> casa::PassiveTableDD::getColumnNamesOfType ( const DataType type ) [protected]

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

virtual Record casa::PassiveTableDD::getOptions ( bool scrub = false ) const [virtual]

Retrieve the current and default options and parameter types.

Reimplemented from casa::PassiveCachingDD.

Reimplemented in casa::SkyCatOverlayDD.

template<class T >

Bool casa::PassiveTableDD::getTableKeyword	(	T &	value,
		const Regex &	regex
	)			const `[inline, protected]`

template<class T >

Bool casa::PassiveTableDD::getTableKeyword	(	T &	value,
		const String	keyword
	)			const `[inline, protected]`

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.

void casa::PassiveTableDD::installDefaultOptions ( ) [private]

Install the default options for this DisplayData.

Reimplemented from casa::CachingDisplayData.

void casa::PassiveTableDD::operator= ( const PassiveTableDD & other ) [protected]

(Required) copy assignment.

Reimplemented from casa::PassiveCachingDD.

Reimplemented in casa::SkyCatOverlayDD.

virtual AttributeBuffer casa::PassiveTableDD::optionsAsAttributes ( ) [virtual]

Return the current options of this DisplayData as an AttributeBuffer.

Reimplemented from casa::PassiveCachingDD.

Reimplemented in casa::SkyCatOverlayDD.

virtual void casa::PassiveTableDD::setDefaultOptions ( ) [virtual]

Install the default options for this DisplayData.

Reimplemented from casa::PassiveCachingDD.

Reimplemented in casa::SkyCatOverlayDD.

virtual Bool casa::PassiveTableDD::setOptions	(	Record &	rec,
		Record &	recOut
	)			`[virtual]`

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.

Reimplemented from casa::PassiveCachingDD.

Reimplemented in casa::SkyCatOverlayDD.

Table* casa::PassiveTableDD::table ( ) [protected]

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.