carma::monitor::SignalPathMapping Class Reference

Class containing convenient accessors to the signal path mapping. More...

#include <carma/monitor/SignalPathMapping.h>

Public Member Functions
bool	changed () const
	Changed Returns true if the signal path mapping has changed since the last call to update. More...
std::vector< int >	getMappedAntennaNumbers () const
	Retrieve ordered antenna numbers for which a signal path is defined. More...
std::set< int >	getMappedAntennaNumbers (const int astroBandNo) const
	Retrieve ordered antenna numbers for which a signal path is defined. More...
std::vector< AntPolPair >	getMappedAntPolPairs (int astroBandNo) const
	For given astroband get ant-pol pairs for which a signal path is defined. More...
std::vector< int >	getMappedAstroBandNumbers () const
	Retrieve ordered astro band numbers for which a signal path is defined. More...
std::vector< BandPolPair >	getMappedBandPolPairs () const
	Retrieve ordered band-pol pairs for which a signal path is defined. More...
std::vector< PolType >	getMappedPolarizations (int astroBandNo) const
	For given astroband retrieve pols for which a signal path is defined. More...
bool	signalPathMapped (int astroBandNo) const
	Determine if a particular astro band is mapped. More...
bool	signalPathMapped (int astroBandNo, const AntPolPair &antPol) const
	Determine if a particular astro band, ant-pol pair is mapped. More...
	SignalPathMapping (const MonitorSystem &monitorSystem, MonitorCorrelatorDesignation corrDes)
	Constructor. More...
bool	update ()
	Update Checks current frame of monitor system for signal path mapping changes. More...
	~SignalPathMapping ()
	Destructor. More...

Detailed Description

Class containing convenient accessors to the signal path mapping.

Definition at line 22 of file SignalPathMapping.h.

Constructor & Destructor Documentation

carma::monitor::SignalPathMapping::SignalPathMapping	(	const MonitorSystem &	monitorSystem,
		MonitorCorrelatorDesignation	corrDes
	)

Constructor.

Parameters

Reference	to monitor system instance.
corrDes	Correlator designation (SPECTRAL, WIDEBAND etc ).

Exceptions

IllegalArgumenException

if corrDes == NONE.

carma::monitor::SignalPathMapping::~SignalPathMapping

(

)

Destructor.

Member Function Documentation

bool carma::monitor::SignalPathMapping::changed

(

)

const

Changed Returns true if the signal path mapping has changed since the last call to update.

Useful for N const references to this class but only a single non-const caller to update (see rtdsignalpath).

Returns

bool True if mapping changed since last update, false otherwise.

std::vector< int > carma::monitor::SignalPathMapping::getMappedAntennaNumbers

(

)

const

Retrieve ordered antenna numbers for which a signal path is defined.

Returns

Possibly empty vector of antenna numbers.

std::set< int > carma::monitor::SignalPathMapping::getMappedAntennaNumbers

(

const int

astroBandNo

)

const

Retrieve ordered antenna numbers for which a signal path is defined.

Returns

Possibly empty vector of antenna numbers.

std::vector< AntPolPair > carma::monitor::SignalPathMapping::getMappedAntPolPairs

(

int

astroBandNo

)

const

For given astroband get ant-pol pairs for which a signal path is defined.

Parameters

astroBandNo

Astro band number.

Returns

Possibly empty vector of AntPolPairs.

std::vector< int > carma::monitor::SignalPathMapping::getMappedAstroBandNumbers

(

)

const

Retrieve ordered astro band numbers for which a signal path is defined.

Returns

Possibly empty vector of astro band numbers.

std::vector< BandPolPair > carma::monitor::SignalPathMapping::getMappedBandPolPairs

(

)

const

Retrieve ordered band-pol pairs for which a signal path is defined.

Returns

Possible empty vector of BandPolPairs.

std::vector< PolType > carma::monitor::SignalPathMapping::getMappedPolarizations

(

int

astroBandNo

)

const

For given astroband retrieve pols for which a signal path is defined.

Parameters

astroBandNo

Astro band number.

Returns

Possibly empty vector of polarizations.

bool carma::monitor::SignalPathMapping::signalPathMapped

(

int

astroBandNo

)

const

Determine if a particular astro band is mapped.

Parameters

astroBandNo

Astro band number.

bool carma::monitor::SignalPathMapping::signalPathMapped	(	int	astroBandNo,
		const AntPolPair &	antPol
	)		const

Determine if a particular astro band, ant-pol pair is mapped.

Parameters

astroBandNo

Astro band number.

bool carma::monitor::SignalPathMapping::update

(

)

Update Checks current frame of monitor system for signal path mapping changes.

Note this routine does not call read or readNewest on the monitor system.

Returns

bool True if mapping has changed, false otherwise.

---

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

• carma/monitor/SignalPathMapping.h