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

#include <yocto_tilt.h>

Inheritance diagram for YTilt:
Inheritance graph
[legend]

Public Member Functions

virtual int _invokeTimedReportCallback (YMeasure value)
 
virtual int _invokeValueCallback (string value)
 
Y_AXIS_enum axis (void)
 
int bandwidth (void)
 
Y_AXIS_enum get_axis (void)
 
int get_bandwidth (void)
 
YTiltnext (void)
 
YTiltnextTilt (void)
 
virtual int registerTimedReportCallback (YTiltTimedReportCallback callback)
 
virtual int registerValueCallback (YTiltValueCallback callback)
 
int set_bandwidth (int newval)
 
int setBandwidth (int newval)
 
 ~YTilt ()
 
- 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 YTiltFind (string func)
 
static YTiltFindTilt (string func)
 
static YTiltFirst (void)
 
static YTiltFirstTilt (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_AXIS_enum AXIS_INVALID = Y_AXIS_INVALID
 
static const Y_AXIS_enum AXIS_X = Y_AXIS_X
 
static const Y_AXIS_enum AXIS_Y = Y_AXIS_Y
 
static const Y_AXIS_enum AXIS_Z = Y_AXIS_Z
 
static const int BANDWIDTH_INVALID = YAPI_INVALID_INT
 
- 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)
 
 YTilt (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_AXIS_enum _axis
 
int _bandwidth
 
YTiltTimedReportCallback _timedReportCallbackTilt
 
YTiltValueCallback _valueCallbackTilt
 
- 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

YTiltyFindTilt (const string &func)
 
YTiltyFirstTilt (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

YTilt Class: Tilt function interface

The YSensor class is the parent class for all Yoctopuce sensors. It can be used to read the current value and unit of any sensor, read the min/max value, configure autonomous recording frequency and access recorded data. It also provide a function to register a callback invoked each time the observed value changes, or at a predefined interval. Using this class rather than a specific subclass makes it possible to create generic applications that work with any Yoctopuce sensor, even those that do not yet exist. Note: The YAnButton class is the only analog input which does not inherit from YSensor.

Definition at line 83 of file yocto_tilt.h.

Constructor & Destructor Documentation

YTilt::YTilt ( const string &  func)
protected

Definition at line 51 of file yocto_tilt.cpp.

YTilt::~YTilt ( )

Definition at line 62 of file yocto_tilt.cpp.

Member Function Documentation

int YTilt::_invokeTimedReportCallback ( YMeasure  value)
virtual

Reimplemented from YSensor.

Definition at line 271 of file yocto_tilt.cpp.

int YTilt::_invokeValueCallback ( string  value)
virtual

Reimplemented from YSensor.

Definition at line 237 of file yocto_tilt.cpp.

int YTilt::_parseAttr ( YJSONObject json_val)
protectedvirtual

Reimplemented from YSensor.

Definition at line 70 of file yocto_tilt.cpp.

Y_AXIS_enum YTilt::axis ( void  )
inline

Definition at line 144 of file yocto_tilt.h.

int YTilt::bandwidth ( void  )
inline

Definition at line 125 of file yocto_tilt.h.

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

Definition at line 209 of file yocto_tilt.h.

YTilt * YTilt::FindTilt ( string  func)
static

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

Definition at line 186 of file yocto_tilt.cpp.

static YTilt* YTilt::First ( void  )
inlinestatic

Definition at line 233 of file yocto_tilt.h.

YTilt * YTilt::FirstTilt ( void  )
static

Starts the enumeration of tilt sensors currently accessible. Use the method YTilt.nextTilt() to iterate on next tilt sensors.

Returns
a pointer to a YTilt object, corresponding to the first tilt sensor currently online, or a NULL pointer if there are none.

Definition at line 291 of file yocto_tilt.cpp.

Y_AXIS_enum YTilt::get_axis ( void  )

Definition at line 137 of file yocto_tilt.cpp.

int YTilt::get_bandwidth ( void  )

Returns the measure update frequency, measured in Hz (Yocto-3D-V2 only).

Returns
an integer corresponding to the measure update frequency, measured in Hz (Yocto-3D-V2 only)

On failure, throws an exception or returns Y_BANDWIDTH_INVALID.

Definition at line 89 of file yocto_tilt.cpp.

YTilt* YTilt::next ( void  )
inline

Definition at line 220 of file yocto_tilt.h.

YTilt * YTilt::nextTilt ( void  )

Continues the enumeration of tilt sensors started using yFirstTilt().

Returns
a pointer to a YTilt object, corresponding to a tilt sensor currently online, or a NULL pointer if there are no more tilt sensors to enumerate.

Definition at line 281 of file yocto_tilt.cpp.

int YTilt::registerTimedReportCallback ( YTiltTimedReportCallback  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 258 of file yocto_tilt.cpp.

int YTilt::registerValueCallback ( YTiltValueCallback  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 218 of file yocto_tilt.cpp.

int YTilt::set_bandwidth ( int  newval)

Changes the measure update frequency, measured in Hz (Yocto-3D-V2 only). When the frequency is lower, the device performs averaging.

Parameters
newval: an integer corresponding to the measure update frequency, measured in Hz (Yocto-3D-V2 only)
Returns
YAPI_SUCCESS if the call succeeds.

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

Definition at line 121 of file yocto_tilt.cpp.

int YTilt::setBandwidth ( int  newval)
inline

Definition at line 139 of file yocto_tilt.h.

Friends And Related Function Documentation

YTilt* yFindTilt ( const string &  func)
friend

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

Definition at line 270 of file yocto_tilt.h.

YTilt* yFirstTilt ( void  )
friend

Starts the enumeration of tilt sensors currently accessible. Use the method YTilt.nextTilt() to iterate on next tilt sensors.

Returns
a pointer to a YTilt object, corresponding to the first tilt sensor currently online, or a NULL pointer if there are none.

Definition at line 281 of file yocto_tilt.h.

Member Data Documentation

Y_AXIS_enum YTilt::_axis
protected

Definition at line 92 of file yocto_tilt.h.

int YTilt::_bandwidth
protected

Definition at line 91 of file yocto_tilt.h.

YTiltTimedReportCallback YTilt::_timedReportCallbackTilt
protected

Definition at line 94 of file yocto_tilt.h.

YTiltValueCallback YTilt::_valueCallbackTilt
protected

Definition at line 93 of file yocto_tilt.h.

const Y_AXIS_enum YTilt::AXIS_INVALID = Y_AXIS_INVALID
static

Definition at line 114 of file yocto_tilt.h.

const Y_AXIS_enum YTilt::AXIS_X = Y_AXIS_X
static

Definition at line 111 of file yocto_tilt.h.

const Y_AXIS_enum YTilt::AXIS_Y = Y_AXIS_Y
static

Definition at line 112 of file yocto_tilt.h.

const Y_AXIS_enum YTilt::AXIS_Z = Y_AXIS_Z
static

Definition at line 113 of file yocto_tilt.h.

const int YTilt::BANDWIDTH_INVALID = YAPI_INVALID_INT
static

Definition at line 110 of file yocto_tilt.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