yocto_magnetometer.h File Reference

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

Include dependency graph for yocto_magnetometer.h:

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

Go to the source code of this file.

Classes
class	YMagnetometer

Macros
#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(*	YMagnetometerTimedReportCallback) (YMagnetometer *func, YMeasure measure)
typedef void(*	YMagnetometerValueCallback) (YMagnetometer *func, const string &functionValue)

Functions
YMagnetometer *	yFindMagnetometer (const string &func)
YMagnetometer *	yFirstMagnetometer (void)

Macro Definition Documentation

#define Y_BANDWIDTH_INVALID   (YAPI_INVALID_INT)

Definition at line 57 of file yocto_magnetometer.h.

#define Y_XVALUE_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 58 of file yocto_magnetometer.h.

#define Y_YVALUE_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 59 of file yocto_magnetometer.h.

#define Y_ZVALUE_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 60 of file yocto_magnetometer.h.

Typedef Documentation

typedef void(* YMagnetometerTimedReportCallback) (YMagnetometer *func, YMeasure measure)

Definition at line 56 of file yocto_magnetometer.h.

typedef void(* YMagnetometerValueCallback) (YMagnetometer *func, const string &functionValue)

Definition at line 54 of file yocto_magnetometer.h.

Function Documentation

YMagnetometer* yFindMagnetometer ( const string &  func )

inline

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

Returns

a YMagnetometer object allowing you to drive the magnetometer.

Definition at line 299 of file yocto_magnetometer.h.

YMagnetometer* yFirstMagnetometer ( void  )

inline

Starts the enumeration of magnetometers currently accessible. Use the method YMagnetometer.nextMagnetometer() to iterate on next magnetometers.

Returns

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

Definition at line 310 of file yocto_magnetometer.h.