yocto_rangefinder.h File Reference

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

Include dependency graph for yocto_rangefinder.h:

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

Go to the source code of this file.

Classes
class	YRangeFinder

Macros
#define	_Y_RANGEFINDERMODE_ENUM
#define	Y_COMMAND_INVALID   (YAPI_INVALID_STRING)
#define	Y_CURRENTTEMPERATURE_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_HARDWARECALIBRATION_INVALID   (YAPI_INVALID_STRING)

Typedefs
typedef void(*	YRangeFinderTimedReportCallback) (YRangeFinder *func, YMeasure measure)
typedef void(*	YRangeFinderValueCallback) (YRangeFinder *func, const string &functionValue)

Enumerations
enum	Y_RANGEFINDERMODE_enum {   Y_RANGEFINDERMODE_DEFAULT = 0, Y_RANGEFINDERMODE_LONG_RANGE = 1, Y_RANGEFINDERMODE_HIGH_ACCURACY = 2, Y_RANGEFINDERMODE_HIGH_SPEED = 3,   Y_RANGEFINDERMODE_INVALID = -1 }

Functions
YRangeFinder *	yFindRangeFinder (const string &func)
YRangeFinder *	yFirstRangeFinder (void)

Macro Definition Documentation

#define _Y_RANGEFINDERMODE_ENUM

Definition at line 58 of file yocto_rangefinder.h.

#define Y_COMMAND_INVALID   (YAPI_INVALID_STRING)

Definition at line 69 of file yocto_rangefinder.h.

#define Y_CURRENTTEMPERATURE_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 68 of file yocto_rangefinder.h.

#define Y_HARDWARECALIBRATION_INVALID   (YAPI_INVALID_STRING)

Definition at line 67 of file yocto_rangefinder.h.

Typedef Documentation

typedef void(* YRangeFinderTimedReportCallback) (YRangeFinder *func, YMeasure measure)

Definition at line 56 of file yocto_rangefinder.h.

typedef void(* YRangeFinderValueCallback) (YRangeFinder *func, const string &functionValue)

Definition at line 54 of file yocto_rangefinder.h.

Enumeration Type Documentation

enum Y_RANGEFINDERMODE_enum

Enumerator
Y_RANGEFINDERMODE_DEFAULT
Y_RANGEFINDERMODE_LONG_RANGE
Y_RANGEFINDERMODE_HIGH_ACCURACY
Y_RANGEFINDERMODE_HIGH_SPEED
Y_RANGEFINDERMODE_INVALID

Definition at line 59 of file yocto_rangefinder.h.

Function Documentation

YRangeFinder* yFindRangeFinder ( const string &  func )

inline

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

Returns

a YRangeFinder object allowing you to drive the range finder.

Definition at line 391 of file yocto_rangefinder.h.

YRangeFinder* yFirstRangeFinder ( void  )

inline

Starts the enumeration of range finders currently accessible. Use the method YRangeFinder.nextRangeFinder() to iterate on next range finders.

Returns

a pointer to a YRangeFinder object, corresponding to the first range finder currently online, or a NULL pointer if there are none.

Definition at line 402 of file yocto_rangefinder.h.