yocto_voc.h File Reference

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

Include dependency graph for yocto_voc.h:

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

Go to the source code of this file.

Classes
class	YVoc

Typedefs
typedef void(*	YVocTimedReportCallback) (YVoc *func, YMeasure measure)
typedef void(*	YVocValueCallback) (YVoc *func, const string &functionValue)

Functions
YVoc *	yFindVoc (const string &func)
YVoc *	yFirstVoc (void)

Typedef Documentation

typedef void(* YVocTimedReportCallback) (YVoc *func, YMeasure measure)

Definition at line 56 of file yocto_voc.h.

typedef void(* YVocValueCallback) (YVoc *func, const string &functionValue)

Definition at line 54 of file yocto_voc.h.

Function Documentation

YVoc* yFindVoc ( const string &  func )

inline

Retrieves a Volatile Organic Compound 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 Volatile Organic Compound sensor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YVoc.isOnline() to test if the Volatile Organic Compound sensor is indeed online at a given time. In case of ambiguity when looking for a Volatile Organic Compound 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 Volatile Organic Compound sensor

Returns

a YVoc object allowing you to drive the Volatile Organic Compound sensor.

Definition at line 213 of file yocto_voc.h.

YVoc* yFirstVoc ( void  )

inline

Starts the enumeration of Volatile Organic Compound sensors currently accessible. Use the method YVoc.nextVoc() to iterate on next Volatile Organic Compound sensors.

Returns

a pointer to a YVoc object, corresponding to the first Volatile Organic Compound sensor currently online, or a NULL pointer if there are none.

Definition at line 224 of file yocto_voc.h.