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

More...

#include <MSSourceIndex.h>

Public Member Functions

 MSSourceIndex ()
 no index attached, use the attach function or assignment operator to change that More...
 
 MSSourceIndex (const MSSource &source)
 construct one using the indicated SOURCE table More...
 
 MSSourceIndex (const MSSourceIndex &other)
 construct one from another More...
 
virtual ~MSSourceIndex ()
 
MSSourceIndexoperator= (const MSSourceIndex &other)
 
void attach (const MSSource &source)
 
IntsourceId ()
 access to the source 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< IntmatchSourceName (const String &name)
 Match a source name or list of source names to a set of SOURCE_ID's. More...
 
Vector< IntmatchSourceName (const Vector< String > &names)
 
Vector< IntmatchSourceCode (const String &code)
 add for source code selection More...
 
RowNumbers getRowNumbersOfSourceID (const Int sid)
 Return rows matching a SourceID. 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

MSSourceColumnsmsSourceCols_p
 Pointer to local MSSourceColumns object. More...
 
RecordFieldPtr< IntsourceId_p
 
RecordFieldPtr< IntspwId_p
 

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 MSSourceIndex.h.

Constructor & Destructor Documentation

◆ MSSourceIndex() [1/3]

casacore::MSSourceIndex::MSSourceIndex ( )

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

◆ MSSourceIndex() [2/3]

casacore::MSSourceIndex::MSSourceIndex ( const MSSource source)

construct one using the indicated SOURCE table

◆ MSSourceIndex() [3/3]

casacore::MSSourceIndex::MSSourceIndex ( const MSSourceIndex other)

construct one from another

◆ ~MSSourceIndex()

virtual casacore::MSSourceIndex::~MSSourceIndex ( )
virtual

Member Function Documentation

◆ attach()

void casacore::MSSourceIndex::attach ( const MSSource source)

◆ attachIds()

void casacore::MSSourceIndex::attachIds ( )
private

◆ compare()

static Int casacore::MSSourceIndex::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

◆ getRowNumbersOfSourceID()

RowNumbers casacore::MSSourceIndex::getRowNumbersOfSourceID ( const Int  sid)

Return rows matching a SourceID.

◆ matchSourceCode()

Vector<Int> casacore::MSSourceIndex::matchSourceCode ( const String code)

add for source code selection

◆ matchSourceName() [1/2]

Vector<Int> casacore::MSSourceIndex::matchSourceName ( const String name)

Match a source name or list of source names to a set of SOURCE_ID's.

◆ matchSourceName() [2/2]

Vector<Int> casacore::MSSourceIndex::matchSourceName ( const Vector< String > &  names)

◆ operator=()

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

◆ sourceId()

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

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

Definition at line 93 of file MSSourceIndex.h.

References sourceId_p.

◆ spectralWindowId()

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

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

Definition at line 97 of file MSSourceIndex.h.

References spwId_p.

Member Data Documentation

◆ msSourceCols_p

MSSourceColumns* casacore::MSSourceIndex::msSourceCols_p
private

Pointer to local MSSourceColumns object.

Definition at line 121 of file MSSourceIndex.h.

◆ sourceId_p

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

Definition at line 123 of file MSSourceIndex.h.

Referenced by sourceId().

◆ spwId_p

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

Definition at line 123 of file MSSourceIndex.h.

Referenced by spectralWindowId().


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