yocto_latitude.h File Reference

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

Include dependency graph for yocto_latitude.h:

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

Go to the source code of this file.

Classes
class	YLatitude

Typedefs
typedef void(*	YLatitudeTimedReportCallback) (YLatitude *func, YMeasure measure)
typedef void(*	YLatitudeValueCallback) (YLatitude *func, const string &functionValue)

Functions
YLatitude *	yFindLatitude (const string &func)
YLatitude *	yFirstLatitude (void)

Typedef Documentation

typedef void(* YLatitudeTimedReportCallback) (YLatitude *func, YMeasure measure)

Definition at line 56 of file yocto_latitude.h.

typedef void(* YLatitudeValueCallback) (YLatitude *func, const string &functionValue)

Definition at line 54 of file yocto_latitude.h.

Function Documentation

YLatitude* yFindLatitude ( const string &  func )

inline

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

Returns

a YLatitude object allowing you to drive the latitude sensor.

Definition at line 214 of file yocto_latitude.h.

YLatitude* yFirstLatitude ( void  )

inline

Starts the enumeration of latitude sensors currently accessible. Use the method YLatitude.nextLatitude() to iterate on next latitude sensors.

Returns

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

Definition at line 225 of file yocto_latitude.h.