casacore::MrsEligibility Class Reference

#include <MeasurementSet.h>

Public Types
typedef MSMainEnums::PredefinedKeywords	SubtableId

Public Member Functions
Bool	isEligible (SubtableId subtableId) const
	Returns true if the specified subtable is in the set of subtables eligible for memory residency.

Static Public Member Functions
static MrsEligibility	allEligible ()
	Factory methods to create MrsEligibility sets.
static MrsEligibility	defaultEligible ()
static MrsEligibility	noneEligible ()
template<typename... SubtableIds>
static MrsEligibility	eligibleSubtables (SubtableIds... subtableIds)
template<typename... SubtableIds>
static MrsEligibility	allButTheseSubtables (SubtableIds... subtableIds)

Private Types
typedef std::set< MSMainEnums::PredefinedKeywords >	Eligible

Static Private Member Functions
static Bool	isSubtable (SubtableId subtableId)

Private Attributes
Eligible	eligible_p

Static Private Attributes
static const MrsEligibility	allSubtables_p

Friends
MrsEligibility	operator- (const MrsEligibility &a, MrsEligibility::SubtableId subtableId)
	Creates a new MrsEligibilitySet by adding or removing the specified subtable or the specified set of subtables.
MrsEligibility	operator+ (const MrsEligibility &a, MrsEligibility::SubtableId subtableId)
MrsEligibility	operator- (const MrsEligibility &a, const MrsEligibility &b)
MrsEligibility	operator+ (const MrsEligibility &a, const MrsEligibility &b)

Detailed Description

Definition at line 54 of file MeasurementSet.h.

Member Typedef Documentation

Eligible

typedef std::set<MSMainEnums::PredefinedKeywords> casacore::MrsEligibility::Eligible

private

Definition at line 118 of file MeasurementSet.h.

SubtableId

typedef MSMainEnums::PredefinedKeywords casacore::MrsEligibility::SubtableId

Definition at line 58 of file MeasurementSet.h.

Member Function Documentation

allButTheseSubtables()

template<typename... SubtableIds>

MrsEligibility casacore::MrsEligibility::allButTheseSubtables ( SubtableIds... subtableIds )

inlinestatic

This function was converted from variable argument functions to using a parameter pack. Because of this, callers specify 'UNDEFINED_KEYWORD' as the last parameter, which can just be ignored.

Get the set of all subtables and then subtract off the caller specified columns. Return the result

Definition at line 95 of file MeasurementSet.h.

References allSubtables_p, eligible_p, isSubtable(), ThrowIf, casacore::String::toString(), and casacore::MSMainEnums::UNDEFINED_KEYWORD.

allEligible()

MrsEligibility casacore::MrsEligibility::allEligible ( )

static

Factory methods to create MrsEligibility sets.

The two functions with parameter packs used to be variable argument functions. Because of this, it used to be required to use the id MSMainEnums::UNDEFINED_KEYWORD as the last parameter. Now that the functions use parameter packs, this is no longer required, and a value of UNDEFINED_KEYWORD is ignored.

defaultEligible()

MrsEligibility casacore::MrsEligibility::defaultEligible ( )

static

eligibleSubtables()

template<typename... SubtableIds>

MrsEligibility casacore::MrsEligibility::eligibleSubtables ( SubtableIds... subtableIds )

inlinestatic

This function was converted from variable argument functions to using a parameter pack. Because of this, callers specify 'UNDEFINED_KEYWORD' as the last parameter, which can just be ignored.

Definition at line 80 of file MeasurementSet.h.

References eligible_p, isSubtable(), ThrowIf, casacore::String::toString(), and casacore::MSMainEnums::UNDEFINED_KEYWORD.

isEligible()

Bool casacore::MrsEligibility::isEligible

(

SubtableId

subtableId

)

const

Returns true if the specified subtable is in the set of subtables eligible for memory residency.

isSubtable()

Bool casacore::MrsEligibility::isSubtable ( SubtableId subtableId )

staticprivate

Referenced by allButTheseSubtables(), and eligibleSubtables().

noneEligible()

MrsEligibility casacore::MrsEligibility::noneEligible ( )

static

Friends And Related Symbol Documentation

operator+ [1/2]

MrsEligibility operator+ ( const MrsEligibility & a, const MrsEligibility & b )

friend

operator+ [2/2]

MrsEligibility operator+ ( const MrsEligibility & a, MrsEligibility::SubtableId subtableId )

friend

operator- [1/2]

MrsEligibility operator- ( const MrsEligibility & a, const MrsEligibility & b )

friend

operator- [2/2]

MrsEligibility operator- ( const MrsEligibility & a, MrsEligibility::SubtableId subtableId )

friend

Creates a new MrsEligibilitySet by adding or removing the specified subtable or the specified set of subtables.

Member Data Documentation

allSubtables_p

const MrsEligibility casacore::MrsEligibility::allSubtables_p

staticprivate

Definition at line 122 of file MeasurementSet.h.

Referenced by allButTheseSubtables().

eligible_p

Eligible casacore::MrsEligibility::eligible_p

private

Definition at line 120 of file MeasurementSet.h.

Referenced by allButTheseSubtables(), and eligibleSubtables().

---

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

• ms/MeasurementSets/MeasurementSet.h