yocto_refframe.h File Reference

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

Include dependency graph for yocto_refframe.h:

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

Go to the source code of this file.

Classes
class	YRefFrame

Macros
#define	_Y_FUSIONMODE_ENUM
#define	_Y_MOUNTORIENTATION
#define	_Y_MOUNTPOSITION
#define	Y_BEARING_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_CALIBRATIONPARAM_INVALID   (YAPI_INVALID_STRING)
#define	Y_MOUNTPOS_INVALID   (YAPI_INVALID_UINT)

Typedefs
typedef void(*	YRefFrameValueCallback) (YRefFrame *func, const string &functionValue)

Enumerations
enum	Y_FUSIONMODE_enum {   Y_FUSIONMODE_NDOF = 0, Y_FUSIONMODE_NDOF_FMC_OFF = 1, Y_FUSIONMODE_M4G = 2, Y_FUSIONMODE_COMPASS = 3,   Y_FUSIONMODE_IMU = 4, Y_FUSIONMODE_INVALID = -1 }
enum	Y_MOUNTORIENTATION {   Y_MOUNTORIENTATION_TWELVE = 0, Y_MOUNTORIENTATION_THREE = 1, Y_MOUNTORIENTATION_SIX = 2, Y_MOUNTORIENTATION_NINE = 3,   Y_MOUNTORIENTATION_INVALID = 4 }
enum	Y_MOUNTPOSITION {   Y_MOUNTPOSITION_BOTTOM = 0, Y_MOUNTPOSITION_TOP = 1, Y_MOUNTPOSITION_FRONT = 2, Y_MOUNTPOSITION_REAR = 3,   Y_MOUNTPOSITION_RIGHT = 4, Y_MOUNTPOSITION_LEFT = 5, Y_MOUNTPOSITION_INVALID = 6 }

Functions
YRefFrame *	yFindRefFrame (const string &func)
YRefFrame *	yFirstRefFrame (void)

Macro Definition Documentation

#define _Y_FUSIONMODE_ENUM

Definition at line 56 of file yocto_refframe.h.

#define _Y_MOUNTORIENTATION

Definition at line 80 of file yocto_refframe.h.

#define _Y_MOUNTPOSITION

Definition at line 67 of file yocto_refframe.h.

#define Y_BEARING_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 91 of file yocto_refframe.h.

#define Y_CALIBRATIONPARAM_INVALID   (YAPI_INVALID_STRING)

Definition at line 92 of file yocto_refframe.h.

#define Y_MOUNTPOS_INVALID   (YAPI_INVALID_UINT)

Definition at line 90 of file yocto_refframe.h.

Typedef Documentation

typedef void(* YRefFrameValueCallback) (YRefFrame *func, const string &functionValue)

Definition at line 54 of file yocto_refframe.h.

Enumeration Type Documentation

enum Y_FUSIONMODE_enum

Enumerator
Y_FUSIONMODE_NDOF
Y_FUSIONMODE_NDOF_FMC_OFF
Y_FUSIONMODE_M4G
Y_FUSIONMODE_COMPASS
Y_FUSIONMODE_IMU
Y_FUSIONMODE_INVALID

Definition at line 57 of file yocto_refframe.h.

enum Y_MOUNTORIENTATION

Enumerator
Y_MOUNTORIENTATION_TWELVE
Y_MOUNTORIENTATION_THREE
Y_MOUNTORIENTATION_SIX
Y_MOUNTORIENTATION_NINE
Y_MOUNTORIENTATION_INVALID

Definition at line 81 of file yocto_refframe.h.

enum Y_MOUNTPOSITION

Enumerator
Y_MOUNTPOSITION_BOTTOM
Y_MOUNTPOSITION_TOP
Y_MOUNTPOSITION_FRONT
Y_MOUNTPOSITION_REAR
Y_MOUNTPOSITION_RIGHT
Y_MOUNTPOSITION_LEFT
Y_MOUNTPOSITION_INVALID

Definition at line 68 of file yocto_refframe.h.

Function Documentation

YRefFrame* yFindRefFrame ( const string &  func )

inline

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

Returns

a YRefFrame object allowing you to drive the reference frame.

Definition at line 536 of file yocto_refframe.h.

YRefFrame* yFirstRefFrame ( void  )

inline

Starts the enumeration of reference frames currently accessible. Use the method YRefFrame.nextRefFrame() to iterate on next reference frames.

Returns

a pointer to a YRefFrame object, corresponding to the first reference frame currently online, or a NULL pointer if there are none.

Definition at line 547 of file yocto_refframe.h.