carma::monitor::ControlSubsystem Class Reference

The monitor system for the Control subsystem. More...

#include <carma/monitor/ControlSubsystemExt.h>

Inherits ControlSubsystemBase.

Public Member Functions
Antenna *	antennaByName (const ::std::string &antennaName)
	Method to return the antenna control container corresponding to a given type qualified antenna name, for example, "Bima1". More...
	ControlSubsystem (SystemFrameBuffer *const buffer=0)
	Constructor. More...
Subarray *	getSubarray (const ::std::string &subarrayName) const
	Method to return the subarray controller container corresponding to a specific subarray name, for example "Science1". More...
::std::set< Antenna * >	getSubarrayAntennaGroup (int subarrayNo) const
virtual	~ControlSubsystem ()
	Destructor. More...

Static Public Member Functions
static int	getMaintenanceSubarrayNo ()
	Returns number of maintenance subarray. More...
::std::string	getSubarrayAlphanumericName (int subarrayNo)
	Returns name of subarray with the correspoding subarray number. More...
::std::string	getSubarrayName (int subarrayNo)
	Returns name of subarray with the correspoding subarray number. More...

Detailed Description

The monitor system for the Control subsystem.

This extends the functionality of the auto-generated class, ControlSubsystemBase.

Definition at line 35 of file ControlSubsystemExt.h.

Constructor & Destructor Documentation

carma::monitor::ControlSubsystem::ControlSubsystem

(

SystemFrameBuffer *const

buffer = 0

)

Constructor.

Parameters

buffer

pointer to system frame storage; NULL within subsystem

virtual carma::monitor::ControlSubsystem::~ControlSubsystem ( )

virtual

Destructor.

Member Function Documentation

Antenna* carma::monitor::ControlSubsystem::antennaByName

(

const ::std::string &

antennaName

)

Method to return the antenna control container corresponding to a given type qualified antenna name, for example, "Bima1".

Returns

antenna pointer to the antenna control container for the antenna corresponding to "antennaName". If not found, zero is returned.

static int carma::monitor::ControlSubsystem::getMaintenanceSubarrayNo ( )

static

Returns number of maintenance subarray.

Subarray* carma::monitor::ControlSubsystem::getSubarray

(

const ::std::string &

subarrayName

)

const

Method to return the subarray controller container corresponding to a specific subarray name, for example "Science1".

Parameters

subarrayname

const ::std::string name of subarray

Returns

Subarray* pointer to the subarray controller container corresponding to the specified subarray, i.e. subarray->name().getValue() == subarrayName NULL if subarrayName is illegal

::std::string carma::monitor::ControlSubsystem::getSubarrayAlphanumericName ( int  subarrayNo )

static

Returns name of subarray with the correspoding subarray number.

Subarray numbers must be in the range 1 to subarrayCount(), since CARMA accomodates only subarrayCount() subarrays.

Parameters

subarrayNumber

int subarray #, must be in [1, subarrayCount()]

Returns

const ::std::string name associated with subarray.

::std::string carma::monitor::ControlSubsystem::getSubarrayName ( int  subarrayNo )

static

Returns name of subarray with the correspoding subarray number.

Subarray numbers must be in the range 1 to subarrayCount(), since CARMA accomodates only subarrayCount() subarrays.

Parameters

subarrayNumber

int subarray #, must be in [1, subarrayCount()]

Returns

const ::std::string name associated with subarray.

---

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

• carma/monitor/ControlSubsystemExt.h