MonitorSystemWithThreshold is a class that contains methods for retrieving and setting threshold values for monitor points. More...

#include <carma/monitor/MonitorSystemWithThreshold.h>

Inheritance diagram for carma::monitor::MonitorSystemWithThreshold:

Public Member Functions
std::vector< std::string >	getAllMonitorPointNames ()
	method for obtaining all monitor point names More...

std::vector< std::string >	getMonitorPointNames (const std::string &searchString)
	method for obtaining monitor point names More...

MonitorPointThreshold &	getThreshold (const std::string &mpName)
	method for obtaining threshold object for a particular MP More...

std::vector < MonitorPointThreshold * >	getThresholds (const std::string &searchString)
	method for obtaining threshold objects More...

template<typename T >
T	getThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type)
	method for obtaining threshold value for a particular MP More...

template<typename T >
T	getThresholdValue (const MonitorPointThreshold &threshold, carma::monitor::ThresholdValueEnum type)
	method for obtaining threshold value for a particular MP More...

template<>
char	getThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type)

template<>
short	getThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type)

template<>
long	getThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type)

template<>
bool	getThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type)

template<>
float	getThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type)

template<>
double	getThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type)

template<>
std::string	getThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type)

template<>
std::complex< float >	getThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type)

template<>
char	getThresholdValue (const MonitorPointThreshold &threshold, carma::monitor::ThresholdValueEnum type)

template<>
short	getThresholdValue (const MonitorPointThreshold &threshold, carma::monitor::ThresholdValueEnum type)

template<>
long	getThresholdValue (const MonitorPointThreshold &threshold, carma::monitor::ThresholdValueEnum type)

template<>
bool	getThresholdValue (const MonitorPointThreshold &threshold, carma::monitor::ThresholdValueEnum type)

template<>
float	getThresholdValue (const MonitorPointThreshold &threshold, carma::monitor::ThresholdValueEnum type)

template<>
double	getThresholdValue (const MonitorPointThreshold &threshold, carma::monitor::ThresholdValueEnum type)

template<>
std::string	getThresholdValue (const MonitorPointThreshold &threshold, carma::monitor::ThresholdValueEnum type)

template<>
std::complex< float >	getThresholdValue (const MonitorPointThreshold &threshold, carma::monitor::ThresholdValueEnum type)

template<typename T >
std::vector< T >	getThresholdValues (const std::string &searchString, carma::monitor::ThresholdValueEnum type)
	method for obtaining threshold values More...

	MonitorSystemWithThreshold (MonitorSystem &monitorSystem)

template<typename T >
void	setThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type, T value)
	method for setting threshold value for a specific mp More...

template<typename T >
void	setThresholdValue (MonitorPointThreshold *threshold, carma::monitor::ThresholdValueEnum type, T value)
	method for setting threshold value for a specific mp More...

template<>
void	setThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type, char value)

template<>
void	setThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type, short value)

template<>
void	setThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type, long value)

template<>
void	setThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type, bool value)

template<>
void	setThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type, float value)

template<>
void	setThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type, double value)

template<>
void	setThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type, std::complex< float > value)

template<>
void	setThresholdValue (const std::string &mpName, carma::monitor::ThresholdValueEnum type, std::string value)

template<>
void	setThresholdValue (MonitorPointThreshold *threshold, carma::monitor::ThresholdValueEnum type, char value)

template<>
void	setThresholdValue (MonitorPointThreshold *threshold, carma::monitor::ThresholdValueEnum type, short value)

template<>
void	setThresholdValue (MonitorPointThreshold *threshold, carma::monitor::ThresholdValueEnum type, long value)

template<>
void	setThresholdValue (MonitorPointThreshold *threshold, carma::monitor::ThresholdValueEnum type, bool value)

template<>
void	setThresholdValue (MonitorPointThreshold *threshold, carma::monitor::ThresholdValueEnum type, float value)

template<>
void	setThresholdValue (MonitorPointThreshold *threshold, carma::monitor::ThresholdValueEnum type, double value)

template<>
void	setThresholdValue (MonitorPointThreshold *threshold, carma::monitor::ThresholdValueEnum type, std::complex< float > value)

template<>
void	setThresholdValue (MonitorPointThreshold *threshold, carma::monitor::ThresholdValueEnum type, std::string value)

template<typename T >
void	setThresholdValues (const std::string &searchString, carma::monitor::ThresholdValueEnum type, T value)
	method for setting threshold values for multiple monitor points using More...

Public Member Functions inherited from carma::monitor::SystemThresholdFrameBuffer
virtual void	calibrateMonitorSystem ()
	Reads latest threshold values from IPQ and sets threshold related validity flags for all monitor points in the MonitorSystem. More...

	SystemThresholdFrameBuffer (MonitorSystem &monitorSystem)
	Constructor - Order of class construction is crucial here. More...

virtual	~SystemThresholdFrameBuffer ()
	Destructor - deletes frame structure if deleteStruct flag was true when the object was constructed. More...

Public Member Functions inherited from carma::monitor::SystemThresholdFrame
long	getMaxNumThresholds () const
	Returns maximum number of allocatable thresholds. More...

long	getNumThresholds () const
	Returns number of allocated thresholds. More...

MonitorPointThreshold &	getThreshold (tagIDType tagID) const
	Returns the MonitorPointThreshold object associated with the monitor point mp such that mp.getTagID() == tagID. More...

	SystemThresholdFrame (MonitorSystem &monitorSystem)
	Constructor - creates a struct using the MonitorSystem, initializes struct with the maxThresholds, sizes it correctly, so the pointers point to meaningful spaces. More...

virtual	~SystemThresholdFrame ()
	Destructor - deletes frame structure. More...

Additional Inherited Members
Protected Member Functions inherited from carma::monitor::SystemThresholdFrame
int	findThreshold (tagIDType tagID) const
	Searches for index to threshold with tagID. More...

ThresholdFrameStruct &	getThresholdFrame () const
	Returns reference to internal ThresholdFrameStruct. More...

ThresholdStruct &	getThresholdStruct (int index) const
	Returns reference to internal ThresholdStruct. More...

Static Protected Member Functions inherited from carma::monitor::SystemThresholdFrame
static ThresholdFrameStruct &	fixupFramePointers (ThresholdFrameStruct &frame)
	Initializes the pointers within the ThresholdFrameStruct to point to meaningful spaces based on the maxNumThresholds member of the structure. More...

static ThresholdFrameStruct &	setThresholdFrameSize (ThresholdFrameStruct &frame, long maxThresholds)
	Initializes size related portions of ThresholdFrameStruct. More...

static size_t	sizeThresholdFrame (long maxThresholds)
	Computes size of threshold frame required to hold. More...

Detailed Description

MonitorSystemWithThreshold is a class that contains methods for retrieving and setting threshold values for monitor points.

Definition at line 30 of file MonitorSystemWithThreshold.h.

Member Function Documentation

std::vector<std::string> carma::monitor::MonitorSystemWithThreshold::getAllMonitorPointNames ( )

method for obtaining all monitor point names

Returns: std::vector of pointers to all monitor point names (std::string)

std::vector<std::string> carma::monitor::MonitorSystemWithThreshold::getMonitorPointNames ( const std::string & searchString )

method for obtaining monitor point names

Parameters

searchString string defining glob pattern for searching for monitor points

Returns: std::vector of pointers to monitor point names (std::string)

MonitorPointThreshold& carma::monitor::MonitorSystemWithThreshold::getThreshold ( const std::string & mpName )

method for obtaining threshold object for a particular MP

Parameters

mpName canonical name for monitor point

Returns: pointer to a MonitorPointThreshold object

std::vector<MonitorPointThreshold*> carma::monitor::MonitorSystemWithThreshold::getThresholds ( const std::string & searchString )

method for obtaining threshold objects

Parameters

searchString string defining glob pattern for searching for monitor points

Returns: std::vector of pointers to MonitorPointThreshold objects

template<typename T >

T carma::monitor::MonitorSystemWithThreshold::getThresholdValue	(	const std::string &	mpName,
		carma::monitor::ThresholdValueEnum	type
	)

method for obtaining threshold value for a particular MP

Parameters

mpName canonical name for monitor point

Returns: pointer to a MonitorPointThreshold object

Definition at line 147 of file MonitorSystemWithThreshold.h.

template<typename T >

T carma::monitor::MonitorSystemWithThreshold::getThresholdValue	(	const MonitorPointThreshold &	threshold,
		carma::monitor::ThresholdValueEnum	type
	)

method for obtaining threshold value for a particular MP

Parameters

threshold reference to MonitorPointThreshold object

Returns: pointer to a MonitorPointThreshold object

Definition at line 248 of file MonitorSystemWithThreshold.h.

template<typename T >

std::vector< T > carma::monitor::MonitorSystemWithThreshold::getThresholdValues	(	const std::string &	searchString,
		carma::monitor::ThresholdValueEnum	type
	)

method for obtaining threshold values

Parameters

searchString string defining glob pattern for searching for monitor points

Returns: std::vector of pointers to MonitorPointThreshold objects

Definition at line 345 of file MonitorSystemWithThreshold.h.

template<typename T >

void carma::monitor::MonitorSystemWithThreshold::setThresholdValue	(	const std::string &	mpName,
		carma::monitor::ThresholdValueEnum	type,
		T	value
	)

method for setting threshold value for a specific mp

Parameters

mpName	canonical name for monitor point
type	threshold type
value	threshold value for monitor point(s)

Definition at line 369 of file MonitorSystemWithThreshold.h.

template<typename T >

void carma::monitor::MonitorSystemWithThreshold::setThresholdValue	(	MonitorPointThreshold *	threshold,
		carma::monitor::ThresholdValueEnum	type,
		T	value
	)

method for setting threshold value for a specific mp

Parameters

mpName	canonical name for monitor point
type	threshold type
value	threshold value for monitor point(s)

Definition at line 481 of file MonitorSystemWithThreshold.h.

template<typename T >

void carma::monitor::MonitorSystemWithThreshold::setThresholdValues	(	const std::string &	searchString,
		carma::monitor::ThresholdValueEnum	type,
		T	value
	)

method for setting threshold values for multiple monitor points using

Parameters

searchString	string defining glob pattern for searching mp names
type	threshold type
value	threshold value for monitor point(s)

Definition at line 125 of file MonitorSystemWithThreshold.h.

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

carma/monitor/MonitorSystemWithThreshold.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation