yocto_compass.h File Reference

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

Include dependency graph for yocto_compass.h:

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

Go to the source code of this file.

Classes
class	YCompass

Macros
#define	_Y_AXIS_ENUM
#define	Y_BANDWIDTH_INVALID   (YAPI_INVALID_INT)
#define	Y_MAGNETICHEADING_INVALID   (YAPI_INVALID_DOUBLE)

Typedefs
typedef void(*	YCompassTimedReportCallback) (YCompass *func, YMeasure measure)
typedef void(*	YCompassValueCallback) (YCompass *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
YCompass *	yFindCompass (const string &func)
YCompass *	yFirstCompass (void)

Macro Definition Documentation

#define _Y_AXIS_ENUM

Definition at line 58 of file yocto_compass.h.

#define Y_BANDWIDTH_INVALID   (YAPI_INVALID_INT)

Definition at line 66 of file yocto_compass.h.

#define Y_MAGNETICHEADING_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 67 of file yocto_compass.h.

Typedef Documentation

typedef void(* YCompassTimedReportCallback) (YCompass *func, YMeasure measure)

Definition at line 56 of file yocto_compass.h.

typedef void(* YCompassValueCallback) (YCompass *func, const string &functionValue)

Definition at line 54 of file yocto_compass.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_compass.h.

Function Documentation

YCompass* yFindCompass ( const string &  func )

inline

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

Returns

a YCompass object allowing you to drive the compass.

Definition at line 285 of file yocto_compass.h.

YCompass* yFirstCompass ( void  )

inline

Starts the enumeration of compasses currently accessible. Use the method YCompass.nextCompass() to iterate on next compasses.

Returns

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

Definition at line 296 of file yocto_compass.h.