yocto_altitude.h File Reference

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

Include dependency graph for yocto_altitude.h:

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

Go to the source code of this file.

Classes
class	YAltitude

Macros
#define	Y_QNH_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_TECHNOLOGY_INVALID   (YAPI_INVALID_STRING)

Typedefs
typedef void(*	YAltitudeTimedReportCallback) (YAltitude *func, YMeasure measure)
typedef void(*	YAltitudeValueCallback) (YAltitude *func, const string &functionValue)

Functions
YAltitude *	yFindAltitude (const string &func)
YAltitude *	yFirstAltitude (void)

Macro Definition Documentation

#define Y_QNH_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 57 of file yocto_altitude.h.

#define Y_TECHNOLOGY_INVALID   (YAPI_INVALID_STRING)

Definition at line 58 of file yocto_altitude.h.

Typedef Documentation

typedef void(* YAltitudeTimedReportCallback) (YAltitude *func, YMeasure measure)

Definition at line 56 of file yocto_altitude.h.

typedef void(* YAltitudeValueCallback) (YAltitude *func, const string &functionValue)

Definition at line 54 of file yocto_altitude.h.

Function Documentation

YAltitude* yFindAltitude ( const string &  func )

inline

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

Returns

a YAltitude object allowing you to drive the altimeter.

Definition at line 283 of file yocto_altitude.h.

YAltitude* yFirstAltitude ( void  )

inline

Starts the enumeration of altimeters currently accessible. Use the method YAltitude.nextAltitude() to iterate on next altimeters.

Returns

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

Definition at line 294 of file yocto_altitude.h.