#include <yocto_voc.h>

Inheritance diagram for YVoc:

Public Member Functions
virtual int	_invokeTimedReportCallback (YMeasure value)

virtual int	_invokeValueCallback (string value)

YVoc *	next (void)

YVoc *	nextVoc (void)

virtual int	registerTimedReportCallback (YVocTimedReportCallback callback)

virtual int	registerValueCallback (YVocValueCallback callback)

	~YVoc ()

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 YVoc *	Find (string func)

static YVoc *	FindVoc (string func)

static YVoc *	First (void)

static YVoc *	FirstVoc (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
	YVoc (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
YVocTimedReportCallback	_timedReportCallbackVoc

YVocValueCallback	_valueCallbackVoc

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
YVoc *	yFindVoc (const string &func)

YVoc *	yFirstVoc (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

YVoc Class: Voc function interface

The Yoctopuce class YVoc allows you to read and configure Yoctopuce Volatile Organic Compound sensors. It inherits from YSensor class the core functions to read measurements, to register callback functions, to access the autonomous datalogger.

Definition at line 67 of file yocto_voc.h.

Constructor & Destructor Documentation

YVoc::YVoc ( const string & func )

protected

Definition at line 51 of file yocto_voc.cpp.

YVoc::~YVoc ( )

Definition at line 60 of file yocto_voc.cpp.

Member Function Documentation

int YVoc::_invokeTimedReportCallback ( YMeasure value )

virtual

Reimplemented from YSensor.

Definition at line 181 of file yocto_voc.cpp.

int YVoc::_invokeValueCallback ( string value )

virtual

Reimplemented from YSensor.

Definition at line 147 of file yocto_voc.cpp.

static YVoc* YVoc::Find ( string func )

inlinestatic

Definition at line 152 of file yocto_voc.h.

YVoc * YVoc::FindVoc ( string func )

static

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

Returns: a YVoc object allowing you to drive the Volatile Organic Compound sensor.

Definition at line 96 of file yocto_voc.cpp.

static YVoc* YVoc::First ( void )

inlinestatic

Definition at line 176 of file yocto_voc.h.

YVoc * YVoc::FirstVoc ( void )

static

Starts the enumeration of Volatile Organic Compound sensors currently accessible. Use the method YVoc.nextVoc() to iterate on next Volatile Organic Compound sensors.

Returns: a pointer to a YVoc object, corresponding to the first Volatile Organic Compound sensor currently online, or a NULL pointer if there are none.

Definition at line 201 of file yocto_voc.cpp.

YVoc* YVoc::next ( void )

inline

Definition at line 163 of file yocto_voc.h.

YVoc * YVoc::nextVoc ( void )

Continues the enumeration of Volatile Organic Compound sensors started using yFirstVoc().

Returns: a pointer to a YVoc object, corresponding to a Volatile Organic Compound sensor currently online, or a NULL pointer if there are no more Volatile Organic Compound sensors to enumerate.

Definition at line 191 of file yocto_voc.cpp.

int YVoc::registerTimedReportCallback ( YVocTimedReportCallback 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 168 of file yocto_voc.cpp.

int YVoc::registerValueCallback ( YVocValueCallback 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 128 of file yocto_voc.cpp.

Friends And Related Function Documentation

YVoc* yFindVoc ( const string & func )

friend

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

Returns: a YVoc object allowing you to drive the Volatile Organic Compound sensor.

Definition at line 213 of file yocto_voc.h.

YVoc* yFirstVoc ( void )

friend

Starts the enumeration of Volatile Organic Compound sensors currently accessible. Use the method YVoc.nextVoc() to iterate on next Volatile Organic Compound sensors.

Returns: a pointer to a YVoc object, corresponding to the first Volatile Organic Compound sensor currently online, or a NULL pointer if there are none.

Definition at line 224 of file yocto_voc.h.

Member Data Documentation

YVocTimedReportCallback YVoc::_timedReportCallbackVoc

protected

Definition at line 76 of file yocto_voc.h.

YVocValueCallback YVoc::_valueCallbackVoc

protected

Definition at line 75 of file yocto_voc.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation