fesa-core-gsi  5.0.1
fesaGSI::CMXMetric< T, CmxType > Class Template Reference

#include <CMXMetric.h>

Inherits fesaGSI::CMXMetricBase< ValueType, CmxType >.

Public Member Functions

 CMXMetric (T &value, CmxType &metric)
 
- Public Member Functions inherited from fesaGSI::CMXMetricBase< ValueType, CmxType >
template<typename T >
get () const
 

Detailed Description

template<typename T, typename CmxType>
class fesaGSI::CMXMetric< T, CmxType >

This class represents a CMX metric. It updates the CMX metric with values read atomically. The memory holding the monitored value must remain accessible throughout the lifetime of this object. This kind of metric should not be used if the underlying value is not updated atomically (consistency is not guaranteed in this case).

Constructor & Destructor Documentation

template<typename T , typename CmxType >
fesaGSI::CMXMetric< T, CmxType >::CMXMetric ( T &  value,
CmxType &  metric 
)
inline

Creates a metric which will monitor the given value. When it is updated, the value will be read and assigned to the CMX metric type. The value is read atomically, and as such must be properly aligned.

Parameters
valuereference to the value to be monitored
metricassociated CMX metric. This object is copied.
Exceptions
FesaExceptionif value's alignment doesn't allow atomic reading.

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