yocto_humidity.h File Reference

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

Include dependency graph for yocto_humidity.h:

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

Go to the source code of this file.

Classes
class	YHumidity

Macros
#define	Y_ABSHUM_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_RELHUM_INVALID   (YAPI_INVALID_DOUBLE)

Typedefs
typedef void(*	YHumidityTimedReportCallback) (YHumidity *func, YMeasure measure)
typedef void(*	YHumidityValueCallback) (YHumidity *func, const string &functionValue)

Functions
YHumidity *	yFindHumidity (const string &func)
YHumidity *	yFirstHumidity (void)

Macro Definition Documentation

#define Y_ABSHUM_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 58 of file yocto_humidity.h.

#define Y_RELHUM_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 57 of file yocto_humidity.h.

Typedef Documentation

typedef void(* YHumidityTimedReportCallback) (YHumidity *func, YMeasure measure)

Definition at line 56 of file yocto_humidity.h.

typedef void(* YHumidityValueCallback) (YHumidity *func, const string &functionValue)

Definition at line 54 of file yocto_humidity.h.

Function Documentation

YHumidity* yFindHumidity ( const string &  func )

inline

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

Returns

a YHumidity object allowing you to drive the humidity sensor.

Definition at line 265 of file yocto_humidity.h.

YHumidity* yFirstHumidity ( void  )

inline

Starts the enumeration of humidity sensors currently accessible. Use the method YHumidity.nextHumidity() to iterate on next humidity sensors.

Returns

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

Definition at line 276 of file yocto_humidity.h.