carma::util::CorrelatorSet Class Reference

CorrelatorSet encapsulates a set of correlators to facilitate management of addition and removal of correlators to a subarray. More...

#include <carma/util/CorrelatorSet.h>

Public Member Functions
void	addC3gMax23 ()
	Add the C3GMAX23 correlator to this set. More...
void	addC3gMax8 ()
	Add the C3GMAX8 correlator to this set. More...
void	addCorrelator (carma::util::CorrelatorType corr)
	Initialize this correlator set. More...
void	addSpectral ()
	Add the spectral correlator to this set. More...
void	addWideband ()
	Add the wideband correlator to this set. More...
	CorrelatorSet ()
	Constructor. More...
	CorrelatorSet (carma::util::CorrelatorType corr)
	Constructor. More...
CorrelatorType	corrType () const
std::string	corrTypeString () const
bool	firstCorrelatorIs (carma::util::CorrelatorType corr) const
carma::util::CorrelatorType	getControlCorrelatorDesignation () const
std::vector < carma::util::CorrelatorType >	getControlCorrelatorDesignations () const
carma::util::CorrelatorType	getFirstControlCorrelatorDesignation () const
bool	includes (const carma::util::CorrelatorType corr) const
bool	includes (const CorrelatorSet &set) const
bool	includesC3gMax23 () const
bool	includesC3gMax8 () const
bool	includesSpectral () const
bool	includesWideband () const
void	initialize (carma::util::CorrelatorType corr)
	Initialize this correlator set. More...
bool	isAll () const
bool	isC3g () const
bool	isC3gMax23 () const
bool	isC3gMax8 () const
bool	isEmpty () const
bool	isSingleCorrelator () const
bool	isSpectral () const
bool	isWideband () const
std::string	mpString () const
unsigned	nCorrelator () const
void	operator= (carma::util::CorrelatorType corr)
	Assignment operator. More...
bool	operator== (carma::util::CorrelatorType corr)
	Equality operator. More...
bool	operator== (const CorrelatorSet &set) const
	Equality operators. More...
void	removeCorrelator (carma::util::CorrelatorType corr)
	Remove a correlator from this set. More...
virtual	~CorrelatorSet ()
	Constructor. More...

Friends
std::ostream &	operator<< (std::ostream &os, const CorrelatorSet &set)
	output stream operator More...

Detailed Description

CorrelatorSet encapsulates a set of correlators to facilitate management of addition and removal of correlators to a subarray.

The class provides methods to discover what kinds of correlators are in the set (SL, WB, C3GMAX8, C3GMAX23), without having to know the detailed bitmask/enum.

Definition at line 33 of file CorrelatorSet.h.

Constructor & Destructor Documentation

carma::util::CorrelatorSet::CorrelatorSet

(

)

Constructor.

carma::util::CorrelatorSet::CorrelatorSet

(

carma::util::CorrelatorType

corr

)

Constructor.

Parameters

correlator

designation enum

virtual carma::util::CorrelatorSet::~CorrelatorSet ( )

virtual

Constructor.

Parameters

corr	monitor namespace correlator designation enum CorrelatorSet(MonitorCorrelatorDesignation corr); Destructor.

Member Function Documentation

void carma::util::CorrelatorSet::addC3gMax23

(

)

Add the C3GMAX23 correlator to this set.

void carma::util::CorrelatorSet::addC3gMax8

(

)

Add the C3GMAX8 correlator to this set.

void carma::util::CorrelatorSet::addCorrelator

(

carma::util::CorrelatorType

corr

)

Initialize this correlator set.

Parameters

corr	monitor namespace correlator designation enum void initialize(MonitorCorrelatorDesignation corr); Add a correlator to this set
corr	correlator designation enum

void carma::util::CorrelatorSet::addSpectral

(

)

Add the spectral correlator to this set.

void carma::util::CorrelatorSet::addWideband

(

)

Add the wideband correlator to this set.

CorrelatorType carma::util::CorrelatorSet::corrType

(

)

const

Returns

the underlying correlator type value

std::string carma::util::CorrelatorSet::corrTypeString

(

)

const

Returns

string representation of enum this correlator set

bool carma::util::CorrelatorSet::firstCorrelatorIs

(

carma::util::CorrelatorType

corr

)

const

Returns

true if the passed correlator is the first one (in bit order) in the set

Parameters

corr	correlator designation enum

carma::util::CorrelatorType carma::util::CorrelatorSet::getControlCorrelatorDesignation

(

)

const

Returns

correlator designation enum for this set

std::vector<carma::util::CorrelatorType> carma::util::CorrelatorSet::getControlCorrelatorDesignations

(

)

const

Returns

vector of correlator Designations that this set includes

carma::util::CorrelatorType carma::util::CorrelatorSet::getFirstControlCorrelatorDesignation

(

)

const

Returns

correlator designation enum of the first (in bit order) correlator in this set

bool carma::util::CorrelatorSet::includes

(

const carma::util::CorrelatorType

corr

)

const

Returns

true if this set includes the specified correlator set

Parameters

corr	correlator designation enum

bool carma::util::CorrelatorSet::includes

(

const CorrelatorSet &

set

)

const

Returns

true if this set includes the specified correlator set

Parameters

set	another CorrelatorSet instance

bool carma::util::CorrelatorSet::includesC3gMax23

(

)

const

Returns

true if this set contains the C3G Max23 correlator.

bool carma::util::CorrelatorSet::includesC3gMax8

(

)

const

Returns

true if this set contains the C3G Max8 correlator.

bool carma::util::CorrelatorSet::includesSpectral

(

)

const

Returns

true if this set contains the spectral correlator.

bool carma::util::CorrelatorSet::includesWideband

(

)

const

Returns

true if this set contains the wideband correlator.

void carma::util::CorrelatorSet::initialize

(

carma::util::CorrelatorType

corr

)

Initialize this correlator set.

Parameters

corr	correlator designation enum

bool carma::util::CorrelatorSet::isAll

(

)

const

Returns

true if this set contains all correlators

bool carma::util::CorrelatorSet::isC3g

(

)

const

Returns

true if this set contains any the C3G band.

bool carma::util::CorrelatorSet::isC3gMax23

(

)

const

Returns

true if this set contains ONLY the C3G Max23 correlator.

bool carma::util::CorrelatorSet::isC3gMax8

(

)

const

Returns

true if this set contains ONLY the C3G Max8 correlator.

bool carma::util::CorrelatorSet::isEmpty

(

)

const

Returns

true if this set is empty

bool carma::util::CorrelatorSet::isSingleCorrelator

(

)

const

Returns

true if this set represents a single correlator

bool carma::util::CorrelatorSet::isSpectral

(

)

const

Returns

true if this set contains ONLY the spectral correlator.

bool carma::util::CorrelatorSet::isWideband

(

)

const

Returns

true if this set contains ONLY the wideband correlator.

std::string carma::util::CorrelatorSet::mpString

(

)

const

Returns

string representation of monitor namespace enum this correlator set

unsigned carma::util::CorrelatorSet::nCorrelator

(

)

const

Returns

the number of correlators contained in this set

void carma::util::CorrelatorSet::operator=

(

carma::util::CorrelatorType

corr

)

Assignment operator.

Parameters

corr	correlator designation enum

bool carma::util::CorrelatorSet::operator==

(

carma::util::CorrelatorType

corr

)

Equality operator.

Parameters

corr	correlator designation enum

bool carma::util::CorrelatorSet::operator==

(

const CorrelatorSet &

set

)

const

Equality operators.

Parameters

set	another CorrelatorSet instance

void carma::util::CorrelatorSet::removeCorrelator

(

carma::util::CorrelatorType

corr

)

Remove a correlator from this set.

Parameters

corr	correlator designation enum

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const CorrelatorSet &  set  )

friend

output stream operator

---

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

• carma/util/CorrelatorSet.h