yocto_tilt.h File Reference

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

Include dependency graph for yocto_tilt.h:

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

Go to the source code of this file.

Classes
class	YTilt

Macros
#define	_Y_AXIS_ENUM
#define	Y_BANDWIDTH_INVALID   (YAPI_INVALID_INT)

Typedefs
typedef void(*	YTiltTimedReportCallback) (YTilt *func, YMeasure measure)
typedef void(*	YTiltValueCallback) (YTilt *func, const string &functionValue)

Enumerations
enum	Y_AXIS_enum {   Y_AXIS_X = 0, Y_AXIS_Y = 1, Y_AXIS_Z = 2, Y_AXIS_INVALID = -1,   Y_AXIS_X = 0, Y_AXIS_Y = 1, Y_AXIS_Z = 2, Y_AXIS_INVALID = -1 }

Functions
YTilt *	yFindTilt (const string &func)
YTilt *	yFirstTilt (void)

Macro Definition Documentation

#define _Y_AXIS_ENUM

Definition at line 58 of file yocto_tilt.h.

#define Y_BANDWIDTH_INVALID   (YAPI_INVALID_INT)

Definition at line 66 of file yocto_tilt.h.

Typedef Documentation

typedef void(* YTiltTimedReportCallback) (YTilt *func, YMeasure measure)

Definition at line 56 of file yocto_tilt.h.

typedef void(* YTiltValueCallback) (YTilt *func, const string &functionValue)

Definition at line 54 of file yocto_tilt.h.

Enumeration Type Documentation

enum Y_AXIS_enum

Enumerator
Y_AXIS_X
Y_AXIS_Y
Y_AXIS_Z
Y_AXIS_INVALID
Y_AXIS_X
Y_AXIS_Y
Y_AXIS_Z
Y_AXIS_INVALID

Definition at line 59 of file yocto_tilt.h.

Function Documentation

YTilt* yFindTilt ( const string &  func )

inline

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

Returns

a YTilt object allowing you to drive the tilt sensor.

Definition at line 270 of file yocto_tilt.h.

YTilt* yFirstTilt ( void  )

inline

Starts the enumeration of tilt sensors currently accessible. Use the method YTilt.nextTilt() to iterate on next tilt sensors.

Returns

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

Definition at line 281 of file yocto_tilt.h.