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

#include <yocto_quadraturedecoder.h>

Inheritance diagram for YQuadratureDecoder:
Inheritance graph
[legend]

Public Member Functions

virtual int _invokeTimedReportCallback (YMeasure value)
 
virtual int _invokeValueCallback (string value)
 
Y_DECODING_enum decoding (void)
 
Y_DECODING_enum get_decoding (void)
 
double get_speed (void)
 
YQuadratureDecodernext (void)
 
YQuadratureDecodernextQuadratureDecoder (void)
 
virtual int registerTimedReportCallback (YQuadratureDecoderTimedReportCallback callback)
 
virtual int registerValueCallback (YQuadratureDecoderValueCallback callback)
 
int set_currentValue (double newval)
 
int set_decoding (Y_DECODING_enum newval)
 
int setCurrentValue (double newval)
 
int setDecoding (Y_DECODING_enum newval)
 
double speed (void)
 
 ~YQuadratureDecoder ()
 
- 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 YDataLoggerget_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)
 
YSensornext (void)
 
YSensornextSensor (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)
 
YModuleget_module (void)
 
void * get_userData (void)
 
bool isOnline (void)
 
YRETCODE load (int msValidity)
 
virtual string loadAttribute (string attrName)
 
string logicalName (void)
 
YModulemodule (void)
 
virtual int muteValueCallbacks (void)
 
YFunctionnext (void)
 
YFunctionnextFunction (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 YQuadratureDecoderFind (string func)
 
static YQuadratureDecoderFindQuadratureDecoder (string func)
 
static YQuadratureDecoderFirst (void)
 
static YQuadratureDecoderFirstQuadratureDecoder (void)
 
- Static Public Member Functions inherited from YSensor
static YSensorFind (string func)
 
static YSensorFindSensor (string func)
 
static YSensorFirst (void)
 
static YSensorFirstSensor (void)
 
- Static Public Member Functions inherited from YFunction
static void _ClearCache (void)
 
static YFunctionFind (string func)
 
static YFunctionFindFunction (string func)
 
static YFunctionFirst (void)
 
static YFunctionFirstFunction (void)
 

Static Public Attributes

static const Y_DECODING_enum DECODING_INVALID = Y_DECODING_INVALID
 
static const Y_DECODING_enum DECODING_OFF = Y_DECODING_OFF
 
static const Y_DECODING_enum DECODING_ON = Y_DECODING_ON
 
static const double SPEED_INVALID = YAPI_INVALID_DOUBLE
 
- 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)
 
 YQuadratureDecoder (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

Y_DECODING_enum _decoding
 
double _speed
 
YQuadratureDecoderTimedReportCallback _timedReportCallbackQuadratureDecoder
 
YQuadratureDecoderValueCallback _valueCallbackQuadratureDecoder
 
- 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

YQuadratureDecoderyFindQuadratureDecoder (const string &func)
 
YQuadratureDecoderyFirstQuadratureDecoder (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

YQuadratureDecoder Class: QuadratureDecoder function interface

The class YQuadratureDecoder allows you to decode a two-wire signal produced by a quadrature encoder. It inherits from YSensor class the core functions to read measurements, to register callback functions, to access the autonomous datalogger.

Definition at line 76 of file yocto_quadraturedecoder.h.

Constructor & Destructor Documentation

YQuadratureDecoder::YQuadratureDecoder ( const string &  func)
protected

Definition at line 51 of file yocto_quadraturedecoder.cpp.

YQuadratureDecoder::~YQuadratureDecoder ( )

Definition at line 62 of file yocto_quadraturedecoder.cpp.

Member Function Documentation

int YQuadratureDecoder::_invokeTimedReportCallback ( YMeasure  value)
virtual

Reimplemented from YSensor.

Definition at line 306 of file yocto_quadraturedecoder.cpp.

int YQuadratureDecoder::_invokeValueCallback ( string  value)
virtual

Reimplemented from YSensor.

Definition at line 272 of file yocto_quadraturedecoder.cpp.

int YQuadratureDecoder::_parseAttr ( YJSONObject json_val)
protectedvirtual

Reimplemented from YSensor.

Definition at line 71 of file yocto_quadraturedecoder.cpp.

Y_DECODING_enum YQuadratureDecoder::decoding ( void  )
inline

Definition at line 144 of file yocto_quadraturedecoder.h.

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

Definition at line 223 of file yocto_quadraturedecoder.h.

YQuadratureDecoder * YQuadratureDecoder::FindQuadratureDecoder ( string  func)
static

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

Definition at line 221 of file yocto_quadraturedecoder.cpp.

static YQuadratureDecoder* YQuadratureDecoder::First ( void  )
inlinestatic

Definition at line 247 of file yocto_quadraturedecoder.h.

YQuadratureDecoder * YQuadratureDecoder::FirstQuadratureDecoder ( void  )
static

Starts the enumeration of quadrature decoders currently accessible. Use the method YQuadratureDecoder.nextQuadratureDecoder() to iterate on next quadrature decoders.

Returns
a pointer to a YQuadratureDecoder object, corresponding to the first quadrature decoder currently online, or a NULL pointer if there are none.

Definition at line 326 of file yocto_quadraturedecoder.cpp.

Y_DECODING_enum YQuadratureDecoder::get_decoding ( void  )

Returns the current activation state of the quadrature decoder.

Returns
either Y_DECODING_OFF or Y_DECODING_ON, according to the current activation state of the quadrature decoder

On failure, throws an exception or returns Y_DECODING_INVALID.

Definition at line 146 of file yocto_quadraturedecoder.cpp.

double YQuadratureDecoder::get_speed ( void  )

Returns the increments frequency, in Hz.

Returns
a floating point number corresponding to the increments frequency, in Hz

On failure, throws an exception or returns Y_SPEED_INVALID.

Definition at line 116 of file yocto_quadraturedecoder.cpp.

YQuadratureDecoder* YQuadratureDecoder::next ( void  )
inline

Definition at line 234 of file yocto_quadraturedecoder.h.

YQuadratureDecoder * YQuadratureDecoder::nextQuadratureDecoder ( void  )

Continues the enumeration of quadrature decoders started using yFirstQuadratureDecoder().

Returns
a pointer to a YQuadratureDecoder object, corresponding to a quadrature decoder currently online, or a NULL pointer if there are no more quadrature decoders to enumerate.

Definition at line 316 of file yocto_quadraturedecoder.cpp.

int YQuadratureDecoder::registerTimedReportCallback ( YQuadratureDecoderTimedReportCallback  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 293 of file yocto_quadraturedecoder.cpp.

int YQuadratureDecoder::registerValueCallback ( YQuadratureDecoderValueCallback  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 253 of file yocto_quadraturedecoder.cpp.

int YQuadratureDecoder::set_currentValue ( double  newval)

Changes the current expected position of the quadrature decoder. Invoking this function implicitely activates the quadrature decoder.

Parameters
newval: a floating point number corresponding to the current expected position of the quadrature decoder
Returns
YAPI_SUCCESS if the call succeeds.

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

Definition at line 93 of file yocto_quadraturedecoder.cpp.

int YQuadratureDecoder::set_decoding ( Y_DECODING_enum  newval)

Changes the activation state of the quadrature decoder.

Parameters
newval: either Y_DECODING_OFF or Y_DECODING_ON, according to the activation state of the quadrature decoder
Returns
YAPI_SUCCESS if the call succeeds.

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

Definition at line 178 of file yocto_quadraturedecoder.cpp.

int YQuadratureDecoder::setCurrentValue ( double  newval)
inline

Definition at line 119 of file yocto_quadraturedecoder.h.

int YQuadratureDecoder::setDecoding ( Y_DECODING_enum  newval)
inline

Definition at line 158 of file yocto_quadraturedecoder.h.

double YQuadratureDecoder::speed ( void  )
inline

Definition at line 131 of file yocto_quadraturedecoder.h.

Friends And Related Function Documentation

YQuadratureDecoder* yFindQuadratureDecoder ( const string &  func)
friend

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

Definition at line 284 of file yocto_quadraturedecoder.h.

YQuadratureDecoder* yFirstQuadratureDecoder ( void  )
friend

Starts the enumeration of quadrature decoders currently accessible. Use the method YQuadratureDecoder.nextQuadratureDecoder() to iterate on next quadrature decoders.

Returns
a pointer to a YQuadratureDecoder object, corresponding to the first quadrature decoder currently online, or a NULL pointer if there are none.

Definition at line 295 of file yocto_quadraturedecoder.h.

Member Data Documentation

Y_DECODING_enum YQuadratureDecoder::_decoding
protected

Definition at line 85 of file yocto_quadraturedecoder.h.

double YQuadratureDecoder::_speed
protected

Definition at line 84 of file yocto_quadraturedecoder.h.

YQuadratureDecoderTimedReportCallback YQuadratureDecoder::_timedReportCallbackQuadratureDecoder
protected

Definition at line 87 of file yocto_quadraturedecoder.h.

YQuadratureDecoderValueCallback YQuadratureDecoder::_valueCallbackQuadratureDecoder
protected

Definition at line 86 of file yocto_quadraturedecoder.h.

const Y_DECODING_enum YQuadratureDecoder::DECODING_INVALID = Y_DECODING_INVALID
static

Definition at line 106 of file yocto_quadraturedecoder.h.

const Y_DECODING_enum YQuadratureDecoder::DECODING_OFF = Y_DECODING_OFF
static

Definition at line 104 of file yocto_quadraturedecoder.h.

const Y_DECODING_enum YQuadratureDecoder::DECODING_ON = Y_DECODING_ON
static

Definition at line 105 of file yocto_quadraturedecoder.h.

const double YQuadratureDecoder::SPEED_INVALID = YAPI_INVALID_DOUBLE
static

Definition at line 103 of file yocto_quadraturedecoder.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