casacore
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::MSDopplerIndex Class Reference

More...

#include <MSDopplerIndex.h>

Public Member Functions

 MSDopplerIndex ()
 no index attached, use the attach function or assignment operator to change that
 
 MSDopplerIndex (const MSDoppler &doppler)
 construct one using the indicated DOPPLER table
 
 MSDopplerIndex (const MSDopplerIndex &other)
 construct one from another
 
virtual ~MSDopplerIndex ()
 
MSDopplerIndexoperator= (const MSDopplerIndex &other)
 
void attach (const MSDoppler &doppler)
 
IntdopplerId ()
 access to the doppler ID key, throws an exception if isNull() is False
 
IntsourceId ()
 access to the source ID key, throws an exception if isNull() is False
 
- Public Member Functions inherited from casacore::MSTableIndex
 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 ()
 
MSTableIndexoperator= (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 RecordaccessKey ()
 access the record of index (integer) keys
 
virtual Doubletime ()
 access the TIME to use in the search (seconds)
 
virtual Doubleinterval ()
 access the INTERVAL to use in the search (seconds), must be >= 0
 
virtual RowNumbers getRowNumbers ()
 get all of the rows in the subTable which have data during the indicated time and interval values.
 
virtual Int64 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 Tabletable ()
 return the subtable being indexed
 

Private Member Functions

void attachIds ()
 

Private Attributes

RecordFieldPtr< IntdopplerId_p
 
RecordFieldPtr< IntsourceId_p
 

Detailed Description

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Synopsis

Example

Motivation

Thrown Exceptions

Definition at line 70 of file MSDopplerIndex.h.

Constructor & Destructor Documentation

◆ MSDopplerIndex() [1/3]

casacore::MSDopplerIndex::MSDopplerIndex ( )

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

◆ MSDopplerIndex() [2/3]

casacore::MSDopplerIndex::MSDopplerIndex ( const MSDoppler doppler)

construct one using the indicated DOPPLER table

◆ MSDopplerIndex() [3/3]

casacore::MSDopplerIndex::MSDopplerIndex ( const MSDopplerIndex other)

construct one from another

◆ ~MSDopplerIndex()

virtual casacore::MSDopplerIndex::~MSDopplerIndex ( )
virtual

Member Function Documentation

◆ attach()

void casacore::MSDopplerIndex::attach ( const MSDoppler doppler)

◆ attachIds()

void casacore::MSDopplerIndex::attachIds ( )
private

◆ dopplerId()

Int & casacore::MSDopplerIndex::dopplerId ( )
inline

access to the doppler ID key, throws an exception if isNull() is False

Definition at line 89 of file MSDopplerIndex.h.

References dopplerId_p.

◆ operator=()

MSDopplerIndex & casacore::MSDopplerIndex::operator= ( const MSDopplerIndex other)

◆ sourceId()

Int & casacore::MSDopplerIndex::sourceId ( )
inline

access to the source ID key, throws an exception if isNull() is False

Definition at line 92 of file MSDopplerIndex.h.

References sourceId_p.

Member Data Documentation

◆ dopplerId_p

RecordFieldPtr<Int> casacore::MSDopplerIndex::dopplerId_p
private

Definition at line 94 of file MSDopplerIndex.h.

Referenced by dopplerId().

◆ sourceId_p

RecordFieldPtr<Int> casacore::MSDopplerIndex::sourceId_p
private

Definition at line 94 of file MSDopplerIndex.h.

Referenced by sourceId().


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