yocto_carbondioxide.h File Reference

#include "yocto_api.h"
#include <cfloat>
#include <cmath>
#include <map>

Include dependency graph for yocto_carbondioxide.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	YCarbonDioxide

Macros
#define	Y_ABCPERIOD_INVALID   (YAPI_INVALID_INT)
#define	Y_COMMAND_INVALID   (YAPI_INVALID_STRING)

Typedefs
typedef void(*	YCarbonDioxideTimedReportCallback) (YCarbonDioxide *func, YMeasure measure)
typedef void(*	YCarbonDioxideValueCallback) (YCarbonDioxide *func, const string &functionValue)

Functions
YCarbonDioxide *	yFindCarbonDioxide (const string &func)
YCarbonDioxide *	yFirstCarbonDioxide (void)

Macro Definition Documentation

#define Y_ABCPERIOD_INVALID   (YAPI_INVALID_INT)

Definition at line 57 of file yocto_carbondioxide.h.

#define Y_COMMAND_INVALID   (YAPI_INVALID_STRING)

Definition at line 58 of file yocto_carbondioxide.h.

Typedef Documentation

typedef void(* YCarbonDioxideTimedReportCallback) (YCarbonDioxide *func, YMeasure measure)

Definition at line 56 of file yocto_carbondioxide.h.

typedef void(* YCarbonDioxideValueCallback) (YCarbonDioxide *func, const string &functionValue)

Definition at line 54 of file yocto_carbondioxide.h.

Function Documentation

YCarbonDioxide* yFindCarbonDioxide ( const string &  func )

inline

Retrieves a CO2 sensor for a given identifier. The identifier can be specified using several formats:

• FunctionLogicalName
• ModuleSerialNumber.FunctionIdentifier
• ModuleSerialNumber.FunctionLogicalName
• ModuleLogicalName.FunctionIdentifier
• ModuleLogicalName.FunctionLogicalName

This function does not require that the CO2 sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YCarbonDioxide.isOnline() to test if the CO2 sensor is indeed online at a given time. In case of ambiguity when looking for a CO2 sensor by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.

If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.

Parameters

func	: a string that uniquely characterizes the CO2 sensor

Returns

a YCarbonDioxide object allowing you to drive the CO2 sensor.

Definition at line 300 of file yocto_carbondioxide.h.

YCarbonDioxide* yFirstCarbonDioxide ( void  )

inline

Starts the enumeration of CO2 sensors currently accessible. Use the method YCarbonDioxide.nextCarbonDioxide() to iterate on next CO2 sensors.

Returns

a pointer to a YCarbonDioxide object, corresponding to the first CO2 sensor currently online, or a NULL pointer if there are none.

Definition at line 311 of file yocto_carbondioxide.h.