yocto_genericsensor.h File Reference

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

Include dependency graph for yocto_genericsensor.h:

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

Go to the source code of this file.

Classes
class	YGenericSensor

Macros
#define	_Y_SIGNALSAMPLING_ENUM
#define	Y_SIGNALBIAS_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_SIGNALRANGE_INVALID   (YAPI_INVALID_STRING)
#define	Y_SIGNALUNIT_INVALID   (YAPI_INVALID_STRING)
#define	Y_SIGNALVALUE_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_VALUERANGE_INVALID   (YAPI_INVALID_STRING)

Typedefs
typedef void(*	YGenericSensorTimedReportCallback) (YGenericSensor *func, YMeasure measure)
typedef void(*	YGenericSensorValueCallback) (YGenericSensor *func, const string &functionValue)

Enumerations
enum	Y_SIGNALSAMPLING_enum {   Y_SIGNALSAMPLING_HIGH_RATE = 0, Y_SIGNALSAMPLING_HIGH_RATE_FILTERED = 1, Y_SIGNALSAMPLING_LOW_NOISE = 2, Y_SIGNALSAMPLING_LOW_NOISE_FILTERED = 3,   Y_SIGNALSAMPLING_INVALID = -1 }

Functions
YGenericSensor *	yFindGenericSensor (const string &func)
YGenericSensor *	yFirstGenericSensor (void)

Macro Definition Documentation

#define _Y_SIGNALSAMPLING_ENUM

Definition at line 58 of file yocto_genericsensor.h.

#define Y_SIGNALBIAS_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 71 of file yocto_genericsensor.h.

#define Y_SIGNALRANGE_INVALID   (YAPI_INVALID_STRING)

Definition at line 69 of file yocto_genericsensor.h.

#define Y_SIGNALUNIT_INVALID   (YAPI_INVALID_STRING)

Definition at line 68 of file yocto_genericsensor.h.

#define Y_SIGNALVALUE_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 67 of file yocto_genericsensor.h.

#define Y_VALUERANGE_INVALID   (YAPI_INVALID_STRING)

Definition at line 70 of file yocto_genericsensor.h.

Typedef Documentation

typedef void(* YGenericSensorTimedReportCallback) (YGenericSensor *func, YMeasure measure)

Definition at line 56 of file yocto_genericsensor.h.

typedef void(* YGenericSensorValueCallback) (YGenericSensor *func, const string &functionValue)

Definition at line 54 of file yocto_genericsensor.h.

Enumeration Type Documentation

enum Y_SIGNALSAMPLING_enum

Enumerator
Y_SIGNALSAMPLING_HIGH_RATE
Y_SIGNALSAMPLING_HIGH_RATE_FILTERED
Y_SIGNALSAMPLING_LOW_NOISE
Y_SIGNALSAMPLING_LOW_NOISE_FILTERED
Y_SIGNALSAMPLING_INVALID

Definition at line 59 of file yocto_genericsensor.h.

Function Documentation

YGenericSensor* yFindGenericSensor ( const string &  func )

inline

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

Returns

a YGenericSensor object allowing you to drive the generic sensor.

Definition at line 418 of file yocto_genericsensor.h.

YGenericSensor* yFirstGenericSensor ( void  )

inline

Starts the enumeration of generic sensors currently accessible. Use the method YGenericSensor.nextGenericSensor() to iterate on next generic sensors.

Returns

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

Definition at line 429 of file yocto_genericsensor.h.