yocto_groundspeed.h File Reference

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

Include dependency graph for yocto_groundspeed.h:

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

Go to the source code of this file.

Classes
class	YGroundSpeed

Typedefs
typedef void(*	YGroundSpeedTimedReportCallback) (YGroundSpeed *func, YMeasure measure)
typedef void(*	YGroundSpeedValueCallback) (YGroundSpeed *func, const string &functionValue)

Functions
YGroundSpeed *	yFindGroundSpeed (const string &func)
YGroundSpeed *	yFirstGroundSpeed (void)

Typedef Documentation

typedef void(* YGroundSpeedTimedReportCallback) (YGroundSpeed *func, YMeasure measure)

Definition at line 56 of file yocto_groundspeed.h.

typedef void(* YGroundSpeedValueCallback) (YGroundSpeed *func, const string &functionValue)

Definition at line 54 of file yocto_groundspeed.h.

Function Documentation

YGroundSpeed* yFindGroundSpeed ( const string &  func )

inline

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

Returns

a YGroundSpeed object allowing you to drive the ground speed sensor.

Definition at line 214 of file yocto_groundspeed.h.

YGroundSpeed* yFirstGroundSpeed ( void  )

inline

Starts the enumeration of ground speed sensors currently accessible. Use the method YGroundSpeed.nextGroundSpeed() to iterate on next ground speed sensors.

Returns

a pointer to a YGroundSpeed object, corresponding to the first ground speed sensor currently online, or a NULL pointer if there are none.

Definition at line 225 of file yocto_groundspeed.h.