yocto_accelerometer.h File Reference

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

Include dependency graph for yocto_accelerometer.h:

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

Go to the source code of this file.

Classes
class	YAccelerometer

Macros
#define	_Y_GRAVITYCANCELLATION_ENUM
#define	Y_BANDWIDTH_INVALID   (YAPI_INVALID_INT)
#define	Y_XVALUE_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_YVALUE_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_ZVALUE_INVALID   (YAPI_INVALID_DOUBLE)

Typedefs
typedef void(*	YAccelerometerTimedReportCallback) (YAccelerometer *func, YMeasure measure)
typedef void(*	YAccelerometerValueCallback) (YAccelerometer *func, const string &functionValue)

Enumerations
enum	Y_GRAVITYCANCELLATION_enum { Y_GRAVITYCANCELLATION_OFF = 0, Y_GRAVITYCANCELLATION_ON = 1, Y_GRAVITYCANCELLATION_INVALID = -1 }

Functions
YAccelerometer *	yFindAccelerometer (const string &func)
YAccelerometer *	yFirstAccelerometer (void)

Macro Definition Documentation

#define _Y_GRAVITYCANCELLATION_ENUM

Definition at line 58 of file yocto_accelerometer.h.

#define Y_BANDWIDTH_INVALID   (YAPI_INVALID_INT)

Definition at line 65 of file yocto_accelerometer.h.

#define Y_XVALUE_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 66 of file yocto_accelerometer.h.

#define Y_YVALUE_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 67 of file yocto_accelerometer.h.

#define Y_ZVALUE_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 68 of file yocto_accelerometer.h.

Typedef Documentation

typedef void(* YAccelerometerTimedReportCallback) (YAccelerometer *func, YMeasure measure)

Definition at line 56 of file yocto_accelerometer.h.

typedef void(* YAccelerometerValueCallback) (YAccelerometer *func, const string &functionValue)

Definition at line 54 of file yocto_accelerometer.h.

Enumeration Type Documentation

enum Y_GRAVITYCANCELLATION_enum

Enumerator
Y_GRAVITYCANCELLATION_OFF
Y_GRAVITYCANCELLATION_ON
Y_GRAVITYCANCELLATION_INVALID

Definition at line 59 of file yocto_accelerometer.h.

Function Documentation

YAccelerometer* yFindAccelerometer ( const string &  func )

inline

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

Returns

a YAccelerometer object allowing you to drive the accelerometer.

Definition at line 317 of file yocto_accelerometer.h.

YAccelerometer* yFirstAccelerometer ( void  )

inline

Starts the enumeration of accelerometers currently accessible. Use the method YAccelerometer.nextAccelerometer() to iterate on next accelerometers.

Returns

a pointer to a YAccelerometer object, corresponding to the first accelerometer currently online, or a NULL pointer if there are none.

Definition at line 328 of file yocto_accelerometer.h.