YQt Class Reference

#include <yocto_gyro.h>

Inheritance diagram for YQt:

Public Member Functions
virtual int	_invokeTimedReportCallback (YMeasure value)
virtual int	_invokeValueCallback (string value)
YQt *	next (void)
YQt *	nextQt (void)
virtual int	registerTimedReportCallback (YQtTimedReportCallback callback)
virtual int	registerValueCallback (YQtValueCallback callback)
	~YQt ()
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 YQt *	Find (string func)
static YQt *	FindQt (string func)
static YQt *	First (void)
static YQt *	FirstQt (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)

Protected Member Functions
	YQt (const string &func)
Protected Member Functions inherited from YSensor
virtual int	_parseAttr (YJSONObject *json_val)
	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
YQtTimedReportCallback	_timedReportCallbackQt
YQtValueCallback	_valueCallbackQt
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
YQt *	yFindQt (const string &func)
YQt *	yFirstQt (void)

Additional Inherited Members
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
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

YQt Class: Quaternion interface

The Yoctopuce API YQt class provides direct access to the Yocto3D attitude estimation using a quaternion. It is usually not needed to use the YQt class directly, as the YGyro class provides a more convenient higher-level interface.

Definition at line 67 of file yocto_gyro.h.

Constructor & Destructor Documentation

YQt::YQt ( const string &  func )

protected

Definition at line 53 of file yocto_gyro.cpp.

YQt::~YQt

(

)

Definition at line 62 of file yocto_gyro.cpp.

Member Function Documentation

int YQt::_invokeTimedReportCallback ( YMeasure  value )

virtual

Reimplemented from YSensor.

Definition at line 183 of file yocto_gyro.cpp.

int YQt::_invokeValueCallback ( string  value )

virtual

Reimplemented from YSensor.

Definition at line 149 of file yocto_gyro.cpp.

static YQt* YQt::Find ( string  func )

inlinestatic

Definition at line 152 of file yocto_gyro.h.

YQt * YQt::FindQt ( string  func )

static

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

Returns

a YQt object allowing you to drive the quaternion component.

Definition at line 98 of file yocto_gyro.cpp.

static YQt* YQt::First ( void  )

inlinestatic

Definition at line 176 of file yocto_gyro.h.

YQt * YQt::FirstQt ( void  )

static

Starts the enumeration of quaternion components currently accessible. Use the method YQt.nextQt() to iterate on next quaternion components.

Returns

a pointer to a YQt object, corresponding to the first quaternion component currently online, or a NULL pointer if there are none.

Definition at line 203 of file yocto_gyro.cpp.

YQt* YQt::next ( void  )

inline

Definition at line 163 of file yocto_gyro.h.

YQt * YQt::nextQt

(

void

)

Continues the enumeration of quaternion components started using yFirstQt().

Returns

a pointer to a YQt object, corresponding to a quaternion component currently online, or a NULL pointer if there are no more quaternion components to enumerate.

Definition at line 193 of file yocto_gyro.cpp.

int YQt::registerTimedReportCallback ( YQtTimedReportCallback  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 170 of file yocto_gyro.cpp.

int YQt::registerValueCallback ( YQtValueCallback  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 130 of file yocto_gyro.cpp.

Friends And Related Function Documentation

YQt* yFindQt ( const string &  func )

friend

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

Returns

a YQt object allowing you to drive the quaternion component.

Definition at line 213 of file yocto_gyro.h.

YQt* yFirstQt ( void  )

friend

Starts the enumeration of quaternion components currently accessible. Use the method YQt.nextQt() to iterate on next quaternion components.

Returns

a pointer to a YQt object, corresponding to the first quaternion component currently online, or a NULL pointer if there are none.

Definition at line 224 of file yocto_gyro.h.

Member Data Documentation

YQtTimedReportCallback YQt::_timedReportCallbackQt

protected

Definition at line 76 of file yocto_gyro.h.

YQtValueCallback YQt::_valueCallbackQt

protected

Definition at line 75 of file yocto_gyro.h.

---

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

• yocto_gyro.h
• yocto_gyro.cpp