casacore
Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::MSFreqOffIndex Class Reference

#include <MSFreqOffIndex.h>

Public Member Functions

 MSFreqOffIndex ()
 no index attached, use the attach function or assignment operator to change that More...
 
 MSFreqOffIndex (const MSFreqOffset &freqOffset)
 construct one using the indicated FREQOFF table More...
 
 MSFreqOffIndex (const MSFreqOffIndex &other)
 construct one from another More...
 
virtual ~MSFreqOffIndex ()
 
MSFreqOffIndex & operator= (const MSFreqOffIndex &other)
 
void attach (const MSFreqOffset &freqOffset)
 
Int & antenna1Id ()
 access to the antenna1 ID key, throws an exception if isNull() is False More...
 
Int & antenna2Id ()
 access to the antenna2 ID key, throws an exception if isNull() is False More...
 
Int & feedId ()
 access to the feed ID key, throws an exception if isNull() is False More...
 
Int & spectralWindowId ()
 access to the spectral window ID key, throws an exception if isNull() is False More...
 
- Public Member Functions inherited from casacore::MSTableIndex
 MSTableIndex ()
 no index attached, use the attach function or assignment operator to change that More...
 
 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. More...
 
 MSTableIndex (const MSTableIndex &other)
 construct one from another More...
 
virtual ~MSTableIndex ()
 
MSTableIndex & operator= (const MSTableIndex &other)
 assignment operator, refernce semantics More...
 
void attach (const Table &subTable, const Vector< String > &indexCols, ColumnsIndex::Compare *compareFunction=0)
 attach this to a subtable using indexCols More...
 
virtual void setChanged ()
 Call this when an index in an existing row has changed. More...
 
virtual Record & accessKey ()
 access the record of index (integer) keys More...
 
virtual Double & time ()
 access the TIME to use in the search (seconds) More...
 
virtual Double & interval ()
 access the INTERVAL to use in the search (seconds), must be >= 0 More...
 
virtual Vector< uInt > getRowNumbers ()
 get all of the rows in the subTable which have data during the indicated time and interval values. More...
 
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()). More...
 
virtual Bool isNull ()
 is this attached to a null table More...
 
virtual Table & table ()
 return the subtable being indexed More...
 

Private Member Functions

void attachIds ()
 

Private Attributes

RecordFieldPtr< Int > antenna1Id_p
 
RecordFieldPtr< Int > antenna2Id_p
 
RecordFieldPtr< Int > feedId_p
 
RecordFieldPtr< Int > spwId_p
 

Detailed Description

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Synopsis

Example

Motivation

Thrown Exceptions

Definition at line 73 of file MSFreqOffIndex.h.

Constructor & Destructor Documentation

◆ MSFreqOffIndex() [1/3]

casacore::MSFreqOffIndex::MSFreqOffIndex ( )

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

◆ MSFreqOffIndex() [2/3]

casacore::MSFreqOffIndex::MSFreqOffIndex ( const MSFreqOffset &  freqOffset)

construct one using the indicated FREQOFF table

◆ MSFreqOffIndex() [3/3]

casacore::MSFreqOffIndex::MSFreqOffIndex ( const MSFreqOffIndex &  other)

construct one from another

◆ ~MSFreqOffIndex()

virtual casacore::MSFreqOffIndex::~MSFreqOffIndex ( )
virtual

Member Function Documentation

◆ antenna1Id()

Int& casacore::MSFreqOffIndex::antenna1Id ( )
inline

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

Definition at line 92 of file MSFreqOffIndex.h.

References antenna1Id_p.

◆ antenna2Id()

Int& casacore::MSFreqOffIndex::antenna2Id ( )
inline

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

Definition at line 95 of file MSFreqOffIndex.h.

References antenna2Id_p.

◆ attach()

void casacore::MSFreqOffIndex::attach ( const MSFreqOffset &  freqOffset)

◆ attachIds()

void casacore::MSFreqOffIndex::attachIds ( )
private

◆ feedId()

Int& casacore::MSFreqOffIndex::feedId ( )
inline

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

Definition at line 98 of file MSFreqOffIndex.h.

References feedId_p.

◆ operator=()

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

◆ spectralWindowId()

Int& casacore::MSFreqOffIndex::spectralWindowId ( )
inline

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

Definition at line 101 of file MSFreqOffIndex.h.

References spwId_p.

Member Data Documentation

◆ antenna1Id_p

RecordFieldPtr<Int> casacore::MSFreqOffIndex::antenna1Id_p
private

Definition at line 103 of file MSFreqOffIndex.h.

Referenced by antenna1Id().

◆ antenna2Id_p

RecordFieldPtr<Int> casacore::MSFreqOffIndex::antenna2Id_p
private

Definition at line 103 of file MSFreqOffIndex.h.

Referenced by antenna2Id().

◆ feedId_p

RecordFieldPtr<Int> casacore::MSFreqOffIndex::feedId_p
private

Definition at line 103 of file MSFreqOffIndex.h.

Referenced by feedId().

◆ spwId_p

RecordFieldPtr<Int> casacore::MSFreqOffIndex::spwId_p
private

Definition at line 103 of file MSFreqOffIndex.h.

Referenced by spectralWindowId().


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