yocto_lightsensor.h File Reference

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

Include dependency graph for yocto_lightsensor.h:

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

Go to the source code of this file.

Classes
class	YLightSensor

Macros
#define	_Y_MEASURETYPE_ENUM

Typedefs
typedef void(*	YLightSensorTimedReportCallback) (YLightSensor *func, YMeasure measure)
typedef void(*	YLightSensorValueCallback) (YLightSensor *func, const string &functionValue)

Enumerations
enum	Y_MEASURETYPE_enum {   Y_MEASURETYPE_HUMAN_EYE = 0, Y_MEASURETYPE_WIDE_SPECTRUM = 1, Y_MEASURETYPE_INFRARED = 2, Y_MEASURETYPE_HIGH_RATE = 3,   Y_MEASURETYPE_HIGH_ENERGY = 4, Y_MEASURETYPE_INVALID = -1 }

Functions
YLightSensor *	yFindLightSensor (const string &func)
YLightSensor *	yFirstLightSensor (void)

Macro Definition Documentation

#define _Y_MEASURETYPE_ENUM

Definition at line 58 of file yocto_lightsensor.h.

Typedef Documentation

typedef void(* YLightSensorTimedReportCallback) (YLightSensor *func, YMeasure measure)

Definition at line 56 of file yocto_lightsensor.h.

typedef void(* YLightSensorValueCallback) (YLightSensor *func, const string &functionValue)

Definition at line 54 of file yocto_lightsensor.h.

Enumeration Type Documentation

enum Y_MEASURETYPE_enum

Enumerator
Y_MEASURETYPE_HUMAN_EYE
Y_MEASURETYPE_WIDE_SPECTRUM
Y_MEASURETYPE_INFRARED
Y_MEASURETYPE_HIGH_RATE
Y_MEASURETYPE_HIGH_ENERGY
Y_MEASURETYPE_INVALID

Definition at line 59 of file yocto_lightsensor.h.

Function Documentation

YLightSensor* yFindLightSensor ( const string &  func )

inline

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

Returns

a YLightSensor object allowing you to drive the light sensor.

Definition at line 289 of file yocto_lightsensor.h.

YLightSensor* yFirstLightSensor ( void  )

inline

Starts the enumeration of light sensors currently accessible. Use the method YLightSensor.nextLightSensor() to iterate on next light sensors.

Returns

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

Definition at line 300 of file yocto_lightsensor.h.