Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
YRangeFinder Class Reference

#include <yocto_rangefinder.h>

Inheritance diagram for YRangeFinder:
Inheritance graph
[legend]

Public Member Functions

virtual int _invokeTimedReportCallback (YMeasure value)
 
virtual int _invokeValueCallback (string value)
 
virtual int cancelCoverGlassCalibrations (void)
 
string command (void)
 
double currentTemperature (void)
 
string get_command (void)
 
double get_currentTemperature (void)
 
string get_hardwareCalibration (void)
 
virtual double get_hardwareCalibrationTemperature (void)
 
Y_RANGEFINDERMODE_enum get_rangeFinderMode (void)
 
string hardwareCalibration (void)
 
YRangeFinder * next (void)
 
YRangeFinder * nextRangeFinder (void)
 
Y_RANGEFINDERMODE_enum rangeFinderMode (void)
 
virtual int registerTimedReportCallback (YRangeFinderTimedReportCallback callback)
 
virtual int registerValueCallback (YRangeFinderValueCallback callback)
 
int set_command (const string &newval)
 
int set_hardwareCalibration (const string &newval)
 
int set_rangeFinderMode (Y_RANGEFINDERMODE_enum newval)
 
int set_unit (const string &newval)
 
int setCommand (const string &newval)
 
int setHardwareCalibration (const string &newval)
 
int setRangeFinderMode (Y_RANGEFINDERMODE_enum newval)
 
int setUnit (const string &newval)
 
virtual int triggerOffsetCalibration (double targetDist)
 
virtual int triggerSpadCalibration (void)
 
virtual int triggerTemperatureCalibration (void)
 
virtual int triggerXTalkCalibration (double targetDist)
 
 ~YRangeFinder ()
 
- Public Member Functions inherited from YSensor
virtual double _applyCalibration (double rawValue)
 
virtual double _decodeAvg (int dw)
 
virtual YMeasure _decodeTimedReport (double timestamp, vector< int > report)
 
virtual double _decodeVal (int w)
 
virtual string _encodeCalibrationPoints (vector< double > rawValues, vector< double > refValues)
 
virtual int _parserHelper (void)
 
Y_ADVMODE_enum advMode (void)
 
virtual int calibrateFromPoints (vector< double > rawValues, vector< double > refValues)
 
string calibrationParam (void)
 
double currentRawValue (void)
 
double currentValue (void)
 
Y_ADVMODE_enum get_advMode (void)
 
string get_calibrationParam (void)
 
double get_currentRawValue (void)
 
double get_currentValue (void)
 
virtual YDataLogger * get_dataLogger (void)
 
double get_highestValue (void)
 
string get_logFrequency (void)
 
double get_lowestValue (void)
 
virtual YDataSet get_recordedData (s64 startTime, s64 endTime)
 
string get_reportFrequency (void)
 
double get_resolution (void)
 
int get_sensorState (void)
 
string get_unit (void)
 
double highestValue (void)
 
virtual bool isSensorReady (void)
 
virtual int loadCalibrationPoints (vector< double > &rawValues, vector< double > &refValues)
 
string logFrequency (void)
 
double lowestValue (void)
 
YSensor * next (void)
 
YSensor * nextSensor (void)
 
virtual int registerTimedReportCallback (YSensorTimedReportCallback callback)
 
virtual int registerValueCallback (YSensorValueCallback callback)
 
string reportFrequency (void)
 
double resolution (void)
 
int sensorState (void)
 
int set_advMode (Y_ADVMODE_enum newval)
 
int set_calibrationParam (const string &newval)
 
int set_highestValue (double newval)
 
int set_logFrequency (const string &newval)
 
int set_lowestValue (double newval)
 
int set_reportFrequency (const string &newval)
 
int set_resolution (double newval)
 
int setAdvMode (Y_ADVMODE_enum newval)
 
int setCalibrationParam (const string &newval)
 
int setHighestValue (double newval)
 
int setLogFrequency (const string &newval)
 
int setLowestValue (double newval)
 
int setReportFrequency (const string &newval)
 
int setResolution (double newval)
 
virtual int startDataLogger (void)
 
virtual int stopDataLogger (void)
 
string unit (void)
 
 ~YSensor ()
 
- Public Member Functions inherited from YFunction
void _clearDataStreamCache ()
 
string _decode_json_string (const string &json)
 
string _download (const string &url)
 
YDataStream * _findDataStream (YDataSet &dataset, const string &def)
 
string _get_json_path (const string &json, const string &path)
 
vector< string > _json_get_array (const string &json)
 
string _json_get_key (const string &json, const string &data)
 
string _json_get_string (const string &json)
 
int _parseEx (yJsonStateMachine &j)
 
string _parseString (yJsonStateMachine &j)
 
string _request (const string &request)
 
string _requestEx (int tcpchan, const string &request, yapiRequestProgressCallback callback, void *context)
 
void _throw (YRETCODE errType, string errMsg)
 
YRETCODE _upload (const string &path, const string &content)
 
YRETCODE _uploadWithProgress (const string &path, const string &content, yapiRequestProgressCallback callback, void *context)
 
string advertisedValue (void)
 
void clearCache ()
 
string describe (void)
 
string errMessage (void)
 
string errorMessage (void)
 
YRETCODE errorType (void)
 
YRETCODE errType (void)
 
YFUN_DESCR functionDescriptor (void)
 
string get_advertisedValue (void)
 
string get_errorMessage (void)
 
YRETCODE get_errorType (void)
 
virtual string get_friendlyName (void)
 
YFUN_DESCR get_functionDescriptor (void)
 
string get_functionId (void)
 
string get_hardwareId (void)
 
string get_hubSerial ()
 
string get_logicalName (void)
 
YModule * get_module (void)
 
void * get_userData (void)
 
bool isOnline (void)
 
YRETCODE load (int msValidity)
 
virtual string loadAttribute (string attrName)
 
string logicalName (void)
 
YModule * module (void)
 
virtual int muteValueCallbacks (void)
 
YFunction * next (void)
 
YFunction * nextFunction (void)
 
virtual int registerValueCallback (YFunctionValueCallback callback)
 
int set_advertisedValue (const string &newval)
 
int set_logicalName (const string &newval)
 
void set_userData (void *data)
 
int setAdvertisedValue (const string &newval)
 
int setLogicalName (const string &newval)
 
void setUserData (void *data)
 
virtual int unmuteValueCallbacks (void)
 
void * userData (void)
 
virtual ~YFunction ()
 

Static Public Member Functions

static YRangeFinder * Find (string func)
 
static YRangeFinder * FindRangeFinder (string func)
 
static YRangeFinder * First (void)
 
static YRangeFinder * FirstRangeFinder (void)
 
- Static Public Member Functions inherited from YSensor
static YSensor * Find (string func)
 
static YSensor * FindSensor (string func)
 
static YSensor * First (void)
 
static YSensor * FirstSensor (void)
 
- Static Public Member Functions inherited from YFunction
static void _ClearCache (void)
 
static YFunction * Find (string func)
 
static YFunction * FindFunction (string func)
 
static YFunction * First (void)
 
static YFunction * FirstFunction (void)
 

Static Public Attributes

static const string COMMAND_INVALID = YAPI_INVALID_STRING
 
static const double CURRENTTEMPERATURE_INVALID = YAPI_INVALID_DOUBLE
 
static const string HARDWARECALIBRATION_INVALID = YAPI_INVALID_STRING
 
static const Y_RANGEFINDERMODE_enum RANGEFINDERMODE_DEFAULT = Y_RANGEFINDERMODE_DEFAULT
 
static const Y_RANGEFINDERMODE_enum RANGEFINDERMODE_HIGH_ACCURACY = Y_RANGEFINDERMODE_HIGH_ACCURACY
 
static const Y_RANGEFINDERMODE_enum RANGEFINDERMODE_HIGH_SPEED = Y_RANGEFINDERMODE_HIGH_SPEED
 
static const Y_RANGEFINDERMODE_enum RANGEFINDERMODE_INVALID = Y_RANGEFINDERMODE_INVALID
 
static const Y_RANGEFINDERMODE_enum RANGEFINDERMODE_LONG_RANGE = Y_RANGEFINDERMODE_LONG_RANGE
 
- Static Public Attributes inherited from YSensor
static const Y_ADVMODE_enum ADVMODE_IMMEDIATE = Y_ADVMODE_IMMEDIATE
 
static const Y_ADVMODE_enum ADVMODE_INVALID = Y_ADVMODE_INVALID
 
static const Y_ADVMODE_enum ADVMODE_PERIOD_AVG = Y_ADVMODE_PERIOD_AVG
 
static const Y_ADVMODE_enum ADVMODE_PERIOD_MAX = Y_ADVMODE_PERIOD_MAX
 
static const Y_ADVMODE_enum ADVMODE_PERIOD_MIN = Y_ADVMODE_PERIOD_MIN
 
static const string CALIBRATIONPARAM_INVALID = YAPI_INVALID_STRING
 
static const double CURRENTRAWVALUE_INVALID = YAPI_INVALID_DOUBLE
 
static const double CURRENTVALUE_INVALID = YAPI_INVALID_DOUBLE
 
static const double HIGHESTVALUE_INVALID = YAPI_INVALID_DOUBLE
 
static const string LOGFREQUENCY_INVALID = YAPI_INVALID_STRING
 
static const double LOWESTVALUE_INVALID = YAPI_INVALID_DOUBLE
 
static const string REPORTFREQUENCY_INVALID = YAPI_INVALID_STRING
 
static const double RESOLUTION_INVALID = YAPI_INVALID_DOUBLE
 
static const int SENSORSTATE_INVALID = YAPI_INVALID_INT
 
static const string UNIT_INVALID = YAPI_INVALID_STRING
 
- Static Public Attributes inherited from YFunction
static const string ADVERTISEDVALUE_INVALID = YAPI_INVALID_STRING
 
static const string FRIENDLYNAME_INVALID = YAPI_INVALID_STRING
 
static const YFUN_DESCR FUNCTIONDESCRIPTOR_INVALID = Y_FUNCTIONDESCRIPTOR_INVALID
 
static const string FUNCTIONID_INVALID = YAPI_INVALID_STRING
 
static const string HARDWAREID_INVALID = YAPI_INVALID_STRING
 
static const string LOGICALNAME_INVALID = YAPI_INVALID_STRING
 

Protected Member Functions

virtual int _parseAttr (YJSONObject *json_val)
 
 YRangeFinder (const string &func)
 
- Protected Member Functions inherited from YSensor
 YSensor (const string &func)
 
- Protected Member Functions inherited from YFunction
YRETCODE _buildSetRequest (const string &changeattr, const string *changeval, string &request, string &errmsg)
 
string _escapeAttr (const string &changeval)
 
YRETCODE _getDescriptor (YFUN_DESCR &fundescr, string &errMsg)
 
YRETCODE _getDevice (YDevice *&dev, string &errMsg)
 
YRETCODE _load_unsafe (int msValidity)
 
YRETCODE _nextFunction (string &hwId)
 
int _parse (YJSONObject *j)
 
YRETCODE _setAttr (string attrname, string newvalue)
 
 YFunction (const string &func)
 

Protected Attributes

string _command
 
double _currentTemperature
 
string _hardwareCalibration
 
Y_RANGEFINDERMODE_enum _rangeFinderMode
 
YRangeFinderTimedReportCallback _timedReportCallbackRangeFinder
 
YRangeFinderValueCallback _valueCallbackRangeFinder
 
- Protected Attributes inherited from YSensor
Y_ADVMODE_enum _advMode
 
yCalibrationHandler _calhdl
 
string _calibrationParam
 
vector< int > _calpar
 
vector< double > _calraw
 
vector< double > _calref
 
int _caltyp
 
double _currentRawValue
 
double _currentValue
 
double _decexp
 
double _highestValue
 
double _iresol
 
bool _isScal
 
bool _isScal32
 
string _logFrequency
 
double _lowestValue
 
double _offset
 
double _prevTimedReport
 
string _reportFrequency
 
double _resolution
 
double _scale
 
int _sensorState
 
YSensorTimedReportCallback _timedReportCallbackSensor
 
string _unit
 
YSensorValueCallback _valueCallbackSensor
 
- Protected Attributes inherited from YFunction
string _advertisedValue
 
u64 _cacheExpiration
 
string _className
 
std::map< string, YDataStream * > _dataStreams
 
string _func
 
YFUN_DESCR _fundescr
 
string _funId
 
string _hwId
 
string _lastErrorMsg
 
YRETCODE _lastErrorType
 
string _logicalName
 
string _serial
 
yCRITICAL_SECTION _this_cs
 
void * _userData
 
YFunctionValueCallback _valueCallbackFunction
 

Friends

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

Additional Inherited Members

- Static Protected Member Functions inherited from YFunction
static void _AddToCache (const string &classname, const string &func, YFunction *obj)
 
static YFunction * _FindFromCache (const string &classname, const string &func)
 
static void _UpdateTimedReportCallbackList (YFunction *func, bool add)
 
static void _UpdateValueCallbackList (YFunction *func, bool add)
 
- Static Protected Attributes inherited from YFunction
static std::map< string, YFunction * > _cache
 

Detailed Description

YRangeFinder Class: RangeFinder function interface

The Yoctopuce class YRangeFinder allows you to use and configure Yoctopuce range finder sensors. It inherits from the YSensor class the core functions to read measurements, register callback functions, access the autonomous datalogger. This class adds the ability to easily perform a one-point linear calibration to compensate the effect of a glass or filter placed in front of the sensor.

Definition at line 82 of file yocto_rangefinder.h.

Constructor & Destructor Documentation

YRangeFinder::YRangeFinder ( const string &  func)
protected

Definition at line 51 of file yocto_rangefinder.cpp.

YRangeFinder::~YRangeFinder ( )

Definition at line 64 of file yocto_rangefinder.cpp.

Member Function Documentation

int YRangeFinder::_invokeTimedReportCallback ( YMeasure  value)
virtual

Reimplemented from YSensor.

Definition at line 399 of file yocto_rangefinder.cpp.

int YRangeFinder::_invokeValueCallback ( string  value)
virtual

Reimplemented from YSensor.

Definition at line 365 of file yocto_rangefinder.cpp.

int YRangeFinder::_parseAttr ( YJSONObject *  json_val)
protectedvirtual

Reimplemented from YSensor.

Definition at line 75 of file yocto_rangefinder.cpp.

int YRangeFinder::cancelCoverGlassCalibrations ( void  )
virtual

Cancels the effect of previous hardware calibration procedures to compensate for cover glass, and restores factory settings. Remember to call the saveToFlash() method of the module if the modification must be kept.

Returns
YAPI_SUCCESS if the call succeeds. On failure, throws an exception or returns a negative error code.

Definition at line 509 of file yocto_rangefinder.cpp.

string YRangeFinder::command ( void  )
inline

Definition at line 191 of file yocto_rangefinder.h.

double YRangeFinder::currentTemperature ( void  )
inline

Definition at line 186 of file yocto_rangefinder.h.

static YRangeFinder* YRangeFinder::Find ( string  func)
inlinestatic

Definition at line 330 of file yocto_rangefinder.h.

YRangeFinder * YRangeFinder::FindRangeFinder ( string  func)
static

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 314 of file yocto_rangefinder.cpp.

static YRangeFinder* YRangeFinder::First ( void  )
inlinestatic

Definition at line 354 of file yocto_rangefinder.h.

YRangeFinder * YRangeFinder::FirstRangeFinder ( void  )
static

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 524 of file yocto_rangefinder.cpp.

string YRangeFinder::get_command ( void  )

Definition at line 249 of file yocto_rangefinder.cpp.

double YRangeFinder::get_currentTemperature ( void  )

Returns the current sensor temperature, as a floating point number.

Returns
a floating point number corresponding to the current sensor temperature, as a floating point number

On failure, throws an exception or returns Y_CURRENTTEMPERATURE_INVALID.

Definition at line 227 of file yocto_rangefinder.cpp.

string YRangeFinder::get_hardwareCalibration ( void  )

Definition at line 182 of file yocto_rangefinder.cpp.

double YRangeFinder::get_hardwareCalibrationTemperature ( void  )
virtual

Returns the temperature at the time when the latest calibration was performed. This function can be used to determine if a new calibration for ambient temperature is required.

Returns
a temperature, as a floating point number. On failure, throws an exception or return YAPI_INVALID_DOUBLE.

Definition at line 417 of file yocto_rangefinder.cpp.

Y_RANGEFINDERMODE_enum YRangeFinder::get_rangeFinderMode ( void  )

Returns the range finder running mode. The rangefinder running mode allows you to put priority on precision, speed or maximum range.

Returns
a value among Y_RANGEFINDERMODE_DEFAULT, Y_RANGEFINDERMODE_LONG_RANGE, Y_RANGEFINDERMODE_HIGH_ACCURACY and Y_RANGEFINDERMODE_HIGH_SPEED corresponding to the range finder running mode

On failure, throws an exception or returns Y_RANGEFINDERMODE_INVALID.

Definition at line 131 of file yocto_rangefinder.cpp.

string YRangeFinder::hardwareCalibration ( void  )
inline

Definition at line 170 of file yocto_rangefinder.h.

YRangeFinder* YRangeFinder::next ( void  )
inline

Definition at line 341 of file yocto_rangefinder.h.

YRangeFinder * YRangeFinder::nextRangeFinder ( void  )

Continues the enumeration of range finders started using yFirstRangeFinder().

Returns
a pointer to a YRangeFinder object, corresponding to a range finder currently online, or a NULL pointer if there are no more range finders to enumerate.

Definition at line 514 of file yocto_rangefinder.cpp.

Y_RANGEFINDERMODE_enum YRangeFinder::rangeFinderMode ( void  )
inline

Definition at line 148 of file yocto_rangefinder.h.

int YRangeFinder::registerTimedReportCallback ( YRangeFinderTimedReportCallback  callback)
virtual

Registers the callback function that is invoked on every periodic timed notification. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a NULL pointer as argument.

Parameters
callback: the callback function to call, or a NULL pointer. The callback function should take two arguments: the function object of which the value has changed, and an YMeasure object describing the new advertised value.

Definition at line 386 of file yocto_rangefinder.cpp.

int YRangeFinder::registerValueCallback ( YRangeFinderValueCallback  callback)
virtual

Registers the callback function that is invoked on every change of advertised value. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a NULL pointer as argument.

Parameters
callback: the callback function to call, or a NULL pointer. The callback function should take two arguments: the function object of which the value has changed, and the character string describing the new advertised value.

Definition at line 346 of file yocto_rangefinder.cpp.

int YRangeFinder::set_command ( const string &  newval)

Definition at line 271 of file yocto_rangefinder.cpp.

int YRangeFinder::set_hardwareCalibration ( const string &  newval)

Definition at line 204 of file yocto_rangefinder.cpp.

int YRangeFinder::set_rangeFinderMode ( Y_RANGEFINDERMODE_enum  newval)

Changes the rangefinder running mode, allowing you to put priority on precision, speed or maximum range.

Parameters
newval: a value among Y_RANGEFINDERMODE_DEFAULT, Y_RANGEFINDERMODE_LONG_RANGE, Y_RANGEFINDERMODE_HIGH_ACCURACY and Y_RANGEFINDERMODE_HIGH_SPEED corresponding to the rangefinder running mode, allowing you to put priority on precision, speed or maximum range
Returns
YAPI_SUCCESS if the call succeeds.

On failure, throws an exception or returns a negative error code.

Definition at line 166 of file yocto_rangefinder.cpp.

int YRangeFinder::set_unit ( const string &  newval)

Changes the measuring unit for the measured range. That unit is a string. String value can be " or mm. Any other value is ignored. Remember to call the saveToFlash() method of the module if the modification must be kept. WARNING: if a specific calibration is defined for the rangeFinder function, a unit system change will probably break it.

Parameters
newval: a string corresponding to the measuring unit for the measured range
Returns
YAPI_SUCCESS if the call succeeds.

On failure, throws an exception or returns a negative error code.

Definition at line 106 of file yocto_rangefinder.cpp.

int YRangeFinder::setCommand ( const string &  newval)
inline

Definition at line 195 of file yocto_rangefinder.h.

int YRangeFinder::setHardwareCalibration ( const string &  newval)
inline

Definition at line 174 of file yocto_rangefinder.h.

int YRangeFinder::setRangeFinderMode ( Y_RANGEFINDERMODE_enum  newval)
inline

Definition at line 165 of file yocto_rangefinder.h.

int YRangeFinder::setUnit ( const string &  newval)
inline

Definition at line 134 of file yocto_rangefinder.h.

int YRangeFinder::triggerOffsetCalibration ( double  targetDist)
virtual

Triggers the hardware offset calibration of the distance sensor. This function is part of the calibration procedure to compensate for the the effect of a cover glass. Make sure to read the chapter about hardware calibration for details on the calibration procedure for proper results.

Parameters
targetDist: true distance of the calibration target, in mm or inches, depending on the unit selected in the device
Returns
YAPI_SUCCESS if the call succeeds. On failure, throws an exception or returns a negative error code.

Definition at line 467 of file yocto_rangefinder.cpp.

int YRangeFinder::triggerSpadCalibration ( void  )
virtual

Triggers the photon detector hardware calibration. This function is part of the calibration procedure to compensate for the the effect of a cover glass. Make sure to read the chapter about hardware calibration for details on the calibration procedure for proper results.

Returns
YAPI_SUCCESS if the call succeeds. On failure, throws an exception or returns a negative error code.

Definition at line 450 of file yocto_rangefinder.cpp.

int YRangeFinder::triggerTemperatureCalibration ( void  )
virtual

Triggers a sensor calibration according to the current ambient temperature. That calibration process needs no physical interaction with the sensor. It is performed automatically at device startup, but it is recommended to start it again when the temperature delta since the latest calibration exceeds 8°C.

Returns
YAPI_SUCCESS if the call succeeds. On failure, throws an exception or returns a negative error code.

Definition at line 436 of file yocto_rangefinder.cpp.

int YRangeFinder::triggerXTalkCalibration ( double  targetDist)
virtual

Triggers the hardware cross-talk calibration of the distance sensor. This function is part of the calibration procedure to compensate for the the effect of a cover glass. Make sure to read the chapter about hardware calibration for details on the calibration procedure for proper results.

Parameters
targetDist: true distance of the calibration target, in mm or inches, depending on the unit selected in the device
Returns
YAPI_SUCCESS if the call succeeds. On failure, throws an exception or returns a negative error code.

Definition at line 490 of file yocto_rangefinder.cpp.

Friends And Related Function Documentation

YRangeFinder* yFindRangeFinder ( const string &  func)
friend

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  )
friend

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.

Member Data Documentation

string YRangeFinder::_command
protected

Definition at line 93 of file yocto_rangefinder.h.

double YRangeFinder::_currentTemperature
protected

Definition at line 92 of file yocto_rangefinder.h.

string YRangeFinder::_hardwareCalibration
protected

Definition at line 91 of file yocto_rangefinder.h.

Y_RANGEFINDERMODE_enum YRangeFinder::_rangeFinderMode
protected

Definition at line 90 of file yocto_rangefinder.h.

YRangeFinderTimedReportCallback YRangeFinder::_timedReportCallbackRangeFinder
protected

Definition at line 95 of file yocto_rangefinder.h.

YRangeFinderValueCallback YRangeFinder::_valueCallbackRangeFinder
protected

Definition at line 94 of file yocto_rangefinder.h.

const string YRangeFinder::COMMAND_INVALID = YAPI_INVALID_STRING
static

Definition at line 118 of file yocto_rangefinder.h.

const double YRangeFinder::CURRENTTEMPERATURE_INVALID = YAPI_INVALID_DOUBLE
static

Definition at line 117 of file yocto_rangefinder.h.

const string YRangeFinder::HARDWARECALIBRATION_INVALID = YAPI_INVALID_STRING
static

Definition at line 116 of file yocto_rangefinder.h.

const Y_RANGEFINDERMODE_enum YRangeFinder::RANGEFINDERMODE_DEFAULT = Y_RANGEFINDERMODE_DEFAULT
static

Definition at line 111 of file yocto_rangefinder.h.

const Y_RANGEFINDERMODE_enum YRangeFinder::RANGEFINDERMODE_HIGH_ACCURACY = Y_RANGEFINDERMODE_HIGH_ACCURACY
static

Definition at line 113 of file yocto_rangefinder.h.

const Y_RANGEFINDERMODE_enum YRangeFinder::RANGEFINDERMODE_HIGH_SPEED = Y_RANGEFINDERMODE_HIGH_SPEED
static

Definition at line 114 of file yocto_rangefinder.h.

const Y_RANGEFINDERMODE_enum YRangeFinder::RANGEFINDERMODE_INVALID = Y_RANGEFINDERMODE_INVALID
static

Definition at line 115 of file yocto_rangefinder.h.

const Y_RANGEFINDERMODE_enum YRangeFinder::RANGEFINDERMODE_LONG_RANGE = Y_RANGEFINDERMODE_LONG_RANGE
static

Definition at line 112 of file yocto_rangefinder.h.

The documentation for this class was generated from the following files:

yoctopuce_altimeter
Author(s): Anja Sheppard
autogenerated on Mon Jun 10 2019 15:49:14