YMeasure Class Reference

#include <yocto_api.h>

Public Member Functions
virtual double	get_averageValue (void)
virtual double	get_endTimeUTC (void)
time_t *	get_endTimeUTC_asTime_t (time_t *time)
virtual double	get_maxValue (void)
virtual double	get_minValue (void)
virtual double	get_startTimeUTC (void)
time_t *	get_startTimeUTC_asTime_t (time_t *time)
	YMeasure (double start, double end, double minVal, double avgVal, double maxVal)
	YMeasure ()

Protected Attributes
double	_avgVal
double	_end
double	_maxVal
double	_minVal
double	_start
time_t	_startTime_t
time_t	_stopTime_t

Detailed Description

YMeasure Class: Measured value

YMeasure objects are used within the API to represent a value measured at a specified time. These objects are used in particular in conjunction with the YDataSet class.

Definition at line 1190 of file yocto_api.h.

Constructor & Destructor Documentation

YMeasure::YMeasure	(	double	start,
		double	end,
		double	minVal,
		double	avgVal,
		double	maxVal
	)

Definition at line 1845 of file yocto_api.cpp.

YMeasure::YMeasure

(

)

Definition at line 1864 of file yocto_api.cpp.

Member Function Documentation

double YMeasure::get_averageValue ( void  )

virtual

Returns the average value observed during the time interval covered by this measure.

Returns

a floating-point number corresponding to the average value observed.

Definition at line 1929 of file yocto_api.cpp.

double YMeasure::get_endTimeUTC ( void  )

virtual

Returns the end time of the measure, relative to the Jan 1, 1970 UTC (Unix timestamp). When the recording rate is higher than 1 sample per second, the timestamp may have a fractional part.

Returns

an floating point number corresponding to the number of seconds between the Jan 1, 1970 UTC and the end of this measure.

Definition at line 1907 of file yocto_api.cpp.

time_t * YMeasure::get_endTimeUTC_asTime_t

(

time_t *

time

)

Definition at line 1954 of file yocto_api.cpp.

double YMeasure::get_maxValue ( void  )

virtual

Returns the largest value observed during the time interval covered by this measure.

Returns

a floating-point number corresponding to the largest value observed.

Definition at line 1940 of file yocto_api.cpp.

double YMeasure::get_minValue ( void  )

virtual

Returns the smallest value observed during the time interval covered by this measure.

Returns

a floating-point number corresponding to the smallest value observed.

Definition at line 1918 of file yocto_api.cpp.

double YMeasure::get_startTimeUTC ( void  )

virtual

Returns the start time of the measure, relative to the Jan 1, 1970 UTC (Unix timestamp). When the recording rate is higher then 1 sample per second, the timestamp may have a fractional part.

Returns

an floating point number corresponding to the number of seconds between the Jan 1, 1970 UTC and the beginning of this measure.

Definition at line 1894 of file yocto_api.cpp.

time_t * YMeasure::get_startTimeUTC_asTime_t

(

time_t *

time

)

Definition at line 1946 of file yocto_api.cpp.

Member Data Documentation

double YMeasure::_avgVal

protected

Definition at line 1201 of file yocto_api.h.

double YMeasure::_end

protected

Definition at line 1199 of file yocto_api.h.

double YMeasure::_maxVal

protected

Definition at line 1202 of file yocto_api.h.

double YMeasure::_minVal

protected

Definition at line 1200 of file yocto_api.h.

double YMeasure::_start

protected

Definition at line 1198 of file yocto_api.h.

time_t YMeasure::_startTime_t

protected

Definition at line 1206 of file yocto_api.h.

time_t YMeasure::_stopTime_t

protected

Definition at line 1207 of file yocto_api.h.

---

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

• yocto_api.h
• yocto_api.cpp