casacore::MSSourceIndex Class Reference

#include <MSSourceIndex.h>

Inheritance diagram for casacore::MSSourceIndex:

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 ()
MSSourceIndex &	operator= (const MSSourceIndex &other)
void	attach (const MSSource &source)
Int &	sourceId ()
	access to the source 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...
Vector< Int >	matchSourceName (const String &name)
	Match a source name or list of source names to a set of SOURCE_ID's. More...
Vector< Int >	matchSourceName (const Vector< String > &names)
Vector< Int >	matchSourceCode (const String &code)
	add for source code selection More...
Vector< uInt >	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 ()
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...

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

Private Member Functions
void	attachIds ()

Private Attributes
ROMSSourceColumns *	msSourceCols_p
	Pointer to local ROMSSourceColumns object. More...
RecordFieldPtr< Int >	sourceId_p
RecordFieldPtr< Int >	spwId_p

Detailed Description

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Prerequisite

• MeasurementSet
• MSTableIndex

Etymology

Synopsis

Example

Motivation

Thrown Exceptions

Definition at line 74 of file MSSourceIndex.h.

Constructor & Destructor Documentation

casacore::MSSourceIndex::MSSourceIndex

(

)

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

casacore::MSSourceIndex::MSSourceIndex

(

const MSSource &

source

)

construct one using the indicated SOURCE table

casacore::MSSourceIndex::MSSourceIndex

(

const MSSourceIndex &

other

)

construct one from another

virtual casacore::MSSourceIndex::~MSSourceIndex ( )

virtual

Member Function Documentation

void casacore::MSSourceIndex::attach

(

const MSSource &

source

)

void casacore::MSSourceIndex::attachIds ( )

private

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

staticprotected

the specialized compare function to pass to the ColumnsIndex object.

This supports -1 values for the SPECTRAL_WINDOW_ID

Vector<uInt> casacore::MSSourceIndex::getRowNumbersOfSourceID

(

const Int

sid

)

Return rows matching a SourceID.

Vector<Int> casacore::MSSourceIndex::matchSourceCode

(

const String &

code

)

add for source code selection

Vector<Int> casacore::MSSourceIndex::matchSourceName

(

const String &

name

)

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

Vector<Int> casacore::MSSourceIndex::matchSourceName

(

const Vector< String > &

names

)

MSSourceIndex& casacore::MSSourceIndex::operator=

(

const MSSourceIndex &

other

)

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.

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

ROMSSourceColumns* casacore::MSSourceIndex::msSourceCols_p

private

Pointer to local ROMSSourceColumns object.

Definition at line 121 of file MSSourceIndex.h.

RecordFieldPtr<Int> casacore::MSSourceIndex::sourceId_p

private

Definition at line 123 of file MSSourceIndex.h.

Referenced by sourceId().

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:

• casa/casacore/ms/MSSel/MSSourceIndex.h