artdaq::MonitoredQuantityStats Struct Reference

struct containing MonitoredQuantity data More...

#include <artdaq-core/Core/MonitoredQuantity.hh>

Inheritance diagram for artdaq::MonitoredQuantityStats:
artdaq::MonitoredQuantity

List of all members.

Public Types

enum  DataSetType { FULL = 0, RECENT = 1 }
 

Which data points to return (all or only recent).

More...
typedef double DURATION_T
 A Duration.
typedef double TIME_POINT_T
 A point in time.

Public Member Functions

long long getSampleCount (DataSetType t=DataSetType::FULL) const
 Returns the sample count for the requested interval.
double getValueSum (DataSetType t=DataSetType::FULL) const
 Returns the sum of values in the requested interval.
double getValueAverage (DataSetType t=DataSetType::FULL) const
 Returns the average of the values in the requested interval.
double getValueRate (DataSetType t=DataSetType::FULL) const
 Returns the sum of the values in the requested interval, divided by the duration of the requested interval.
double getValueRMS (DataSetType t=DataSetType::FULL) const
 Returns the RMS of the values in the requested interval.
double getValueMin (DataSetType t=DataSetType::FULL) const
 Returns the smallest of the values in the requested interval.
double getValueMax (DataSetType t=DataSetType::FULL) const
 Returns the largest of the values in the requested interval.
DURATION_T getDuration (DataSetType t=DataSetType::FULL) const
 Returns the duration of the requested interval.
double getSampleRate (DataSetType t=DataSetType::FULL) const
 Returns the sample rate in the requested interval.
double getSampleLatency (DataSetType t=DataSetType::FULL) const
double getLastSampleValue () const
 Accessor for the last sample value recorded.
double getLastValueRate () const
 Accessor for the lastValueRate (Sum of last samples over interval between calculateStatisics calls).
bool isEnabled () const
 Access the enable flag.

Public Attributes

long long fullSampleCount
 The total number of samples represented.
double fullSampleRate
 The total number of samples over the full duration of sampling.
double fullValueSum
 The sum of all samples.
double fullValueSumOfSquares
 The sum of the squares of all samples.
double fullValueAverage
 The average of all samples.
double fullValueRMS
 The RMS of all samples.
double fullValueMin
 The smallest value of all samples.
double fullValueMax
 The largest value of all sampels.
double fullValueRate
 The sum of all samples over the full duration of sampling.
DURATION_T fullDuration
 The full duration of sampling.
long long recentSampleCount
 The number of samples in the "recent" time window.
double recentSampleRate
 The number of samples in the "recent" time window, divided by the length of that window.
double recentValueSum
 The sum of the "recent" samples.
double recentValueSumOfSquares
 The sum of the squares of the "recent" samples.
double recentValueAverage
 The average of the "recent" samples.
double recentValueRMS
 The RMS of the 'recent samples.
double recentValueMin
 The smallest value of the "recent" samples.
double recentValueMax
 The largest value of the "recent" samples.
double recentValueRate
 The sum of the "recent" samples, divided by the length of the "recent" time window.
DURATION_T recentDuration
 The length of the "recent" time window.
std::vector< long long > recentBinnedSampleCounts
 Sample counts for each instance of calculateStatistics in _intervalForRecentStats (rolling window).
std::vector< double > recentBinnedValueSums
 Sums for each instance of calculateStatistics in _intervalForRecentStats (rolling window).
std::vector< DURATION_TrecentBinnedDurations
 Duration between each instance of calcualteStatistics in _intervalForRecentStats (rolling window).
std::vector< TIME_POINT_TrecentBinnedEndTimes
 Last sample time in each instance of calculateStatistics in _intervalForRecentStats (rolling window).
double lastSampleValue
 Value of the most recent sample.
double lastValueRate
 Latest rate point (sum of values over calculateStatistics interval).
TIME_POINT_T lastCalculationTime
 Last time calculateStatistics was called.
bool enabled
 Whether the MonitoredQuantity is collecting data.

Detailed Description

struct containing MonitoredQuantity data

Definition at line 15 of file MonitoredQuantity.hh.


Member Enumeration Documentation

Which data points to return (all or only recent).

Enumerator:
FULL 

the full data set (all samples)

RECENT 

recent data only

Definition at line 23 of file MonitoredQuantity.hh.


Member Function Documentation

DURATION_T artdaq::MonitoredQuantityStats::getDuration ( DataSetType  t = DataSetType::FULL  )  const [inline]

Returns the duration of the requested interval.

Parameters:
t Which interval to return, DataSetType::FULL (default) or DataSetType::RECENT
Returns:
The duration of the requested interval

Definition at line 115 of file MonitoredQuantity.hh.

double artdaq::MonitoredQuantityStats::getLastSampleValue (  )  const [inline]

Accessor for the last sample value recorded.

Returns:
The last sample value recorded

Definition at line 139 of file MonitoredQuantity.hh.

double artdaq::MonitoredQuantityStats::getLastValueRate (  )  const [inline]

Accessor for the lastValueRate (Sum of last samples over interval between calculateStatisics calls).

Returns:
The lastValueRate (Sum of last samples over interval between calculateStatisics calls)

Definition at line 145 of file MonitoredQuantity.hh.

long long artdaq::MonitoredQuantityStats::getSampleCount ( DataSetType  t = DataSetType::FULL  )  const [inline]

Returns the sample count for the requested interval.

Parameters:
t Which interval to return, DataSetType::FULL (default) or DataSetType::RECENT
Returns:
The sample count for the requested interval

Definition at line 66 of file MonitoredQuantity.hh.

double artdaq::MonitoredQuantityStats::getSampleLatency ( DataSetType  t = DataSetType::FULL  )  const [inline]
Parameters:
t Which interval to return, DataSetType::FULL (default) or DataSetType::RECENT
Returns:

Definition at line 129 of file MonitoredQuantity.hh.

double artdaq::MonitoredQuantityStats::getSampleRate ( DataSetType  t = DataSetType::FULL  )  const [inline]

Returns the sample rate in the requested interval.

Parameters:
t Which interval to return, DataSetType::FULL (default) or DataSetType::RECENT
Returns:
The sample rate in the requested interval

Definition at line 122 of file MonitoredQuantity.hh.

double artdaq::MonitoredQuantityStats::getValueAverage ( DataSetType  t = DataSetType::FULL  )  const [inline]

Returns the average of the values in the requested interval.

Parameters:
t Which interval to return, DataSetType::FULL (default) or DataSetType::RECENT
Returns:
The average of the values in the requested interval

Definition at line 80 of file MonitoredQuantity.hh.

double artdaq::MonitoredQuantityStats::getValueMax ( DataSetType  t = DataSetType::FULL  )  const [inline]

Returns the largest of the values in the requested interval.

Parameters:
t Which interval to return, DataSetType::FULL (default) or DataSetType::RECENT
Returns:
The largest of the values in the requested interval

Definition at line 108 of file MonitoredQuantity.hh.

double artdaq::MonitoredQuantityStats::getValueMin ( DataSetType  t = DataSetType::FULL  )  const [inline]

Returns the smallest of the values in the requested interval.

Parameters:
t Which interval to return, DataSetType::FULL (default) or DataSetType::RECENT
Returns:
The smallest of the values in the requested interval

Definition at line 101 of file MonitoredQuantity.hh.

double artdaq::MonitoredQuantityStats::getValueRate ( DataSetType  t = DataSetType::FULL  )  const [inline]

Returns the sum of the values in the requested interval, divided by the duration of the requested interval.

Parameters:
t Which interval to return, DataSetType::FULL (default) or DataSetType::RECENT
Returns:
The sum of the values in the requested interval, divided by the duration of the requested interval

Definition at line 87 of file MonitoredQuantity.hh.

double artdaq::MonitoredQuantityStats::getValueRMS ( DataSetType  t = DataSetType::FULL  )  const [inline]

Returns the RMS of the values in the requested interval.

Parameters:
t Which interval to return, DataSetType::FULL (default) or DataSetType::RECENT
Returns:
The RMS of the values in the requested interval

Definition at line 94 of file MonitoredQuantity.hh.

double artdaq::MonitoredQuantityStats::getValueSum ( DataSetType  t = DataSetType::FULL  )  const [inline]

Returns the sum of values in the requested interval.

Parameters:
t Which interval to return, DataSetType::FULL (default) or DataSetType::RECENT
Returns:
The sum of values in the requested interval

Definition at line 73 of file MonitoredQuantity.hh.

bool artdaq::MonitoredQuantityStats::isEnabled (  )  const [inline]

Access the enable flag.

Returns:
The current value of the enable flag

Reimplemented in artdaq::MonitoredQuantity.

Definition at line 151 of file MonitoredQuantity.hh.


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

Generated on 19 Feb 2018 for artdaq_core by  doxygen 1.6.1