#include <MSTableIndex.h>

Inheritance diagram for casa::MSTableIndex:

Public Member Functions
	MSTableIndex ()
	no index attached, use the attach function or assignment operator to change that
	MSTableIndex (const Table &subTable, const Vector< String > &indexCols, ColumnsIndex::Compare *compareFunction=0)
	construct one using the indicated subtable which is part of the parent MS using the indicated index columns.
	MSTableIndex (const MSTableIndex &other)
	construct one from another
virtual	~MSTableIndex ()
MSTableIndex &	operator= (const MSTableIndex &other)
	assignment operator, refernce semantics
void	attach (const Table &subTable, const Vector< String > &indexCols, ColumnsIndex::Compare *compareFunction=0)
	attach this to a subtable using indexCols
virtual void	setChanged ()
	Call this when an index in an existing row has changed.
virtual Record &	accessKey ()
	access the record of index (integer) keys
virtual Double &	time ()
	access the TIME to use in the search (seconds)
virtual Double &	interval ()
	access the INTERVAL to use in the search (seconds), must be >= 0
virtual Vector< uInt >	getRowNumbers ()
	get all of the rows in the subTable which have data during the indicated time and interval values.
virtual uInt	getNearestRow (Bool &found)
	get the row number which falls in the interval and has the time nearest to the center of the interval (time()).
virtual Bool	isNull ()
	is this attached to a null table
virtual Table &	table ()
	return the subtable being indexed
Private Member Functions
void	clear ()
void	makeKeys ()
Bool	keysChanged ()
void	getInternals ()
void	nearestTime ()
Private Attributes
Table	tab_p
	the subtable
ROScalarColumn< Double >	timeColumn_p
ROScalarColumn< Double >	intervalColumn_p
Vector< Double >	timeVec_p
Vector< Double >	intervalVec_p
const Double *	timeVals_p
const Double *	intervalVals_p
Bool	deleteItTime_p
Bool	deleteItInterval_p
Record *	key_p
	Internal keys - set by user.
Block< RecordFieldPtr< Int > >	intKeys_p
Double	time_p
Double	interval_p
Vector< Int >	lastKeys_p
	last known integer key values
Double	lastTime_p
	last known time and interval
Double	lastInterval_p
Vector< uInt >	lastSearch_p
	last search result - matching integer keys
Int	lastNearest_p
	last nearest
Bool	nearestFound_p
Bool	nearestReady_p
uInt	nrows_p
	last known sub-table size
Bool	hasChanged_p
ColumnsIndex *	index_p
Block< RecordFieldPtr< Int > >	indexKeys_p
Bool	hasTime_p
Bool	hasInterval_p

Detailed Description

Intended use:

Public interface

 <h3>Review Status</h3><dl><dt>Date Reviewed:<dd>yyyy/mm/dd</dl>

Prerequisite

Etymology

Synopsis

Example

Motivation

Thrown Exceptions

To Do

Make the searches smarter - for TIME sorted tables, if the time to search is past the last seach, there's no need to search any earlier times.
Need to handle the INTERVAL=-1 case fully

Definition at line 81 of file MSTableIndex.h.

Constructor & Destructor Documentation

casa::MSTableIndex::MSTableIndex ( )

no index attached, use the attach function or assignment operator to change that

casa::MSTableIndex::MSTableIndex	(	const Table &	subTable,
		const Vector< String > &	indexCols,
		ColumnsIndex::Compare *	compareFunction = `0`
	)

construct one using the indicated subtable which is part of the parent MS using the indicated index columns.

All index columns must be scalar integer columns. TIME and INTERVAL will be used when present. A compare function can be provided to over-ride literal matching of column values.

casa::MSTableIndex::MSTableIndex ( const MSTableIndex & other )

construct one from another

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

Member Function Documentation

virtual Record& casa::MSTableIndex::accessKey ( ) [inline, virtual]

access the record of index (integer) keys

Definition at line 111 of file MSTableIndex.h.

References key_p.

void casa::MSTableIndex::attach	(	const Table &	subTable,
		const Vector< String > &	indexCols,
		ColumnsIndex::Compare *	compareFunction = `0`
	)

attach this to a subtable using indexCols

void casa::MSTableIndex::clear ( ) [private]

void casa::MSTableIndex::getInternals ( ) [private]

virtual uInt casa::MSTableIndex::getNearestRow ( Bool & found ) [virtual]

get the row number which falls in the interval and has the time nearest to the center of the interval (time()).

This also has the same problem as the previous function.

virtual Vector<uInt> casa::MSTableIndex::getRowNumbers ( ) [virtual]

get all of the rows in the subTable which have data during the indicated time and interval values.

For now, this code will miss the case where the subtable has interval = -1 and the start time is outside of the time range implied by the time and interval. If the table has changed and the time is >

virtual Double& casa::MSTableIndex::interval ( ) [inline, virtual]

access the INTERVAL to use in the search (seconds), must be >= 0

Definition at line 117 of file MSTableIndex.h.

References interval_p.

virtual Bool casa::MSTableIndex::isNull ( ) [inline, virtual]

is this attached to a null table

Definition at line 130 of file MSTableIndex.h.

References casa::Table::isNull(), and tab_p.

Bool casa::MSTableIndex::keysChanged ( ) [private]