casacore
Public Member Functions | Static Protected Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::MSFeedIndex Class Reference

More...

#include <MSFeedIndex.h>

Public Member Functions

 MSFeedIndex ()
 no index attached, use the attach function or assignment operator to change that More...
 
 MSFeedIndex (const MSFeed &feed)
 construct one using the indicated FEED table More...
 
 MSFeedIndex (const MSFeedIndex &other)
 construct one from another More...
 
virtual ~MSFeedIndex ()
 
MSFeedIndexoperator= (const MSFeedIndex &other)
 
void attach (const MSFeed &feed)
 
IntantennaId ()
 access to the antenna ID key, throws an exception if isNull() is False More...
 
IntfeedId ()
 access to the feed ID key, throws an exception if isNull() is False More...
 
IntspectralWindowId ()
 access to the spectral window ID key, throws an exception if isNull() is False More...
 
Vector< IntmatchFeedPolznAndAngle (const Int &antennaId, const Vector< String > &polznType, const Vector< Float > &receptorAngle, const Float &tol, Vector< Int > &rowNumbers)
 return feed id. More...
 
Vector< IntmatchAntennaId (const Int &antennaId, Vector< Int > &rowNumbers)
 return feed id. More...
 
Vector< IntmatchFeedId (const Vector< Int > &sourceId)
 return valid feed id. 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 ()
 
MSTableIndexoperator= (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 RecordaccessKey ()
 access the record of index (integer) keys More...
 
virtual Doubletime ()
 access the TIME to use in the search (seconds) More...
 
virtual Doubleinterval ()
 access the INTERVAL to use in the search (seconds), must be >= 0 More...
 
virtual RowNumbers getRowNumbers ()
 get all of the rows in the subTable which have data during the indicated time and interval values. More...
 
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()). More...
 
virtual Bool isNull ()
 is this attached to a null table More...
 
virtual Tabletable ()
 return the subtable being indexed More...
 

Static Protected Member Functions

static Int compare (const Block< void * > &fieldPtrs, const Block< void * > &dataPtrs, const Block< Int > &dataTypes, rownr_t index)
 the specialized compare function to pass to the ColumnsIndex object. More...
 

Private Member Functions

void attachIds ()
 

Private Attributes

RecordFieldPtr< IntantennaId_p
 
RecordFieldPtr< IntfeedId_p
 
RecordFieldPtr< IntspwId_p
 
MSFeedColumnsmsFeedCols_p
 Pointer to FEED columns accessor. More...
 

Detailed Description

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Synopsis

Example

Motivation

Thrown Exceptions

Definition at line 74 of file MSFeedIndex.h.

Constructor & Destructor Documentation

◆ MSFeedIndex() [1/3]

casacore::MSFeedIndex::MSFeedIndex ( )

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

◆ MSFeedIndex() [2/3]

casacore::MSFeedIndex::MSFeedIndex ( const MSFeed feed)

construct one using the indicated FEED table

◆ MSFeedIndex() [3/3]

casacore::MSFeedIndex::MSFeedIndex ( const MSFeedIndex other)

construct one from another

◆ ~MSFeedIndex()

virtual casacore::MSFeedIndex::~MSFeedIndex ( )
virtual

Member Function Documentation

◆ antennaId()

Int& casacore::MSFeedIndex::antennaId ( )
inline

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

Definition at line 93 of file MSFeedIndex.h.

References antennaId_p.

◆ attach()

void casacore::MSFeedIndex::attach ( const MSFeed feed)

◆ attachIds()

void casacore::MSFeedIndex::attachIds ( )
private

◆ compare()

static Int casacore::MSFeedIndex::compare ( const Block< void * > &  fieldPtrs,
const Block< void * > &  dataPtrs,
const Block< Int > &  dataTypes,
rownr_t  index 
)
staticprotected

the specialized compare function to pass to the ColumnsIndex object.

This supports -1 values for the SPECTRAL_WINDOW_ID

◆ feedId()

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

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

Definition at line 96 of file MSFeedIndex.h.

References feedId_p.

◆ matchAntennaId()

Vector<Int> casacore::MSFeedIndex::matchAntennaId ( const Int antennaId,
Vector< Int > &  rowNumbers 
)

return feed id.

's (and associated row numbers) for a given antenna id.

◆ matchFeedId()

Vector<Int> casacore::MSFeedIndex::matchFeedId ( const Vector< Int > &  sourceId)

return valid feed id.

's for a given list of feed id.'s.

◆ matchFeedPolznAndAngle()

Vector<Int> casacore::MSFeedIndex::matchFeedPolznAndAngle ( const Int antennaId,
const Vector< String > &  polznType,
const Vector< Float > &  receptorAngle,
const Float tol,
Vector< Int > &  rowNumbers 
)

return feed id.

's (and associated row numbers) for a given antenna id., polzn type and receptor angle

◆ operator=()

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

◆ spectralWindowId()

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

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

Definition at line 99 of file MSFeedIndex.h.

References spwId_p.

Member Data Documentation

◆ antennaId_p

RecordFieldPtr<Int> casacore::MSFeedIndex::antennaId_p
private

Definition at line 125 of file MSFeedIndex.h.

Referenced by antennaId().

◆ feedId_p

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

Definition at line 125 of file MSFeedIndex.h.

Referenced by feedId().

◆ msFeedCols_p

MSFeedColumns* casacore::MSFeedIndex::msFeedCols_p
private

Pointer to FEED columns accessor.

Definition at line 128 of file MSFeedIndex.h.

◆ spwId_p

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

Definition at line 125 of file MSFeedIndex.h.

Referenced by spectralWindowId().


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