yocto_longitude.h File Reference

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

Include dependency graph for yocto_longitude.h:

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

Go to the source code of this file.

Classes
class	YLongitude

Typedefs
typedef void(*	YLongitudeTimedReportCallback) (YLongitude *func, YMeasure measure)
typedef void(*	YLongitudeValueCallback) (YLongitude *func, const string &functionValue)

Functions
YLongitude *	yFindLongitude (const string &func)
YLongitude *	yFirstLongitude (void)

Typedef Documentation

typedef void(* YLongitudeTimedReportCallback) (YLongitude *func, YMeasure measure)

Definition at line 56 of file yocto_longitude.h.

typedef void(* YLongitudeValueCallback) (YLongitude *func, const string &functionValue)

Definition at line 54 of file yocto_longitude.h.

Function Documentation

YLongitude* yFindLongitude ( const string &  func )

inline

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

Returns

a YLongitude object allowing you to drive the longitude sensor.

Definition at line 214 of file yocto_longitude.h.

YLongitude* yFirstLongitude ( void  )

inline

Starts the enumeration of longitude sensors currently accessible. Use the method YLongitude.nextLongitude() to iterate on next longitude sensors.

Returns

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

Definition at line 225 of file yocto_longitude.h.