#include <yocto_proximity.h>

Inheritance diagram for YProximity:

Public Member Functions
virtual int	_invokeTimedReportCallback (YMeasure value)

virtual int	_invokeValueCallback (string value)

int	detectionThreshold (void)

int	get_detectionThreshold (void)

Y_ISPRESENT_enum	get_isPresent (void)

s64	get_lastTimeApproached (void)

s64	get_lastTimeRemoved (void)

Y_PROXIMITYREPORTMODE_enum	get_proximityReportMode (void)

s64	get_pulseCounter (void)

s64	get_pulseTimer (void)

double	get_signalValue (void)

Y_ISPRESENT_enum	isPresent (void)

s64	lastTimeApproached (void)

s64	lastTimeRemoved (void)

YProximity *	next (void)

YProximity *	nextProximity (void)

Y_PROXIMITYREPORTMODE_enum	proximityReportMode (void)

s64	pulseCounter (void)

s64	pulseTimer (void)

virtual int	registerTimedReportCallback (YProximityTimedReportCallback callback)

virtual int	registerValueCallback (YProximityValueCallback callback)

virtual int	resetCounter (void)

int	set_detectionThreshold (int newval)

int	set_proximityReportMode (Y_PROXIMITYREPORTMODE_enum newval)

int	set_pulseCounter (s64 newval)

int	setDetectionThreshold (int newval)

int	setProximityReportMode (Y_PROXIMITYREPORTMODE_enum newval)

int	setPulseCounter (s64 newval)

double	signalValue (void)

	~YProximity ()

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

static YProximity *	FindProximity (string func)

static YProximity *	First (void)

static YProximity *	FirstProximity (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 int	DETECTIONTHRESHOLD_INVALID = YAPI_INVALID_UINT

static const Y_ISPRESENT_enum	ISPRESENT_FALSE = Y_ISPRESENT_FALSE

static const Y_ISPRESENT_enum	ISPRESENT_INVALID = Y_ISPRESENT_INVALID

static const Y_ISPRESENT_enum	ISPRESENT_TRUE = Y_ISPRESENT_TRUE

static const s64	LASTTIMEAPPROACHED_INVALID = YAPI_INVALID_LONG

static const s64	LASTTIMEREMOVED_INVALID = YAPI_INVALID_LONG

static const Y_PROXIMITYREPORTMODE_enum	PROXIMITYREPORTMODE_INVALID = Y_PROXIMITYREPORTMODE_INVALID

static const Y_PROXIMITYREPORTMODE_enum	PROXIMITYREPORTMODE_NUMERIC = Y_PROXIMITYREPORTMODE_NUMERIC

static const Y_PROXIMITYREPORTMODE_enum	PROXIMITYREPORTMODE_PRESENCE = Y_PROXIMITYREPORTMODE_PRESENCE

static const Y_PROXIMITYREPORTMODE_enum	PROXIMITYREPORTMODE_PULSECOUNT = Y_PROXIMITYREPORTMODE_PULSECOUNT

static const s64	PULSECOUNTER_INVALID = YAPI_INVALID_LONG

static const s64	PULSETIMER_INVALID = YAPI_INVALID_LONG

static const double	SIGNALVALUE_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)

	YProximity (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
int	_detectionThreshold

Y_ISPRESENT_enum	_isPresent

s64	_lastTimeApproached

s64	_lastTimeRemoved

Y_PROXIMITYREPORTMODE_enum	_proximityReportMode

s64	_pulseCounter

s64	_pulseTimer

double	_signalValue

YProximityTimedReportCallback	_timedReportCallbackProximity

YProximityValueCallback	_valueCallbackProximity

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
YProximity *	yFindProximity (const string &func)

YProximity *	yFirstProximity (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

YProximity Class: Proximity function interface

The Yoctopuce class YProximity allows you to use and configure Yoctopuce proximity sensors. It inherits from the YSensor class the core functions to read measurements, to register callback functions, to 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 92 of file yocto_proximity.h.

Constructor & Destructor Documentation

YProximity::YProximity ( const string & func )

protected

Definition at line 51 of file yocto_proximity.cpp.

YProximity::~YProximity ( )

Definition at line 68 of file yocto_proximity.cpp.

Member Function Documentation

int YProximity::_invokeTimedReportCallback ( YMeasure value )

virtual

Reimplemented from YSensor.

Definition at line 541 of file yocto_proximity.cpp.

int YProximity::_invokeValueCallback ( string value )

virtual

Reimplemented from YSensor.

Definition at line 507 of file yocto_proximity.cpp.

int YProximity::_parseAttr ( YJSONObject * json_val )

protectedvirtual

Reimplemented from YSensor.

Definition at line 77 of file yocto_proximity.cpp.

int YProximity::detectionThreshold ( void )

inline

Definition at line 163 of file yocto_proximity.h.

static YProximity* YProximity::Find ( string func )

inlinestatic

Definition at line 360 of file yocto_proximity.h.

YProximity * YProximity::FindProximity ( string func )

static

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

Returns: a YProximity object allowing you to drive the proximity sensor.

Definition at line 456 of file yocto_proximity.cpp.

static YProximity* YProximity::First ( void )

inlinestatic

Definition at line 384 of file yocto_proximity.h.

YProximity * YProximity::FirstProximity ( void )

static

Starts the enumeration of proximity sensors currently accessible. Use the method YProximity.nextProximity() to iterate on next proximity sensors.

Returns: a pointer to a YProximity object, corresponding to the first proximity sensor currently online, or a NULL pointer if there are none.

Definition at line 573 of file yocto_proximity.cpp.

int YProximity::get_detectionThreshold ( void )

Returns the threshold used to determine the logical state of the proximity sensor, when considered as a binary input (on/off).

Returns: an integer corresponding to the threshold used to determine the logical state of the proximity sensor, when considered as a binary input (on/off)

On failure, throws an exception or returns Y_DETECTIONTHRESHOLD_INVALID.

Definition at line 146 of file yocto_proximity.cpp.

Y_ISPRESENT_enum YProximity::get_isPresent ( void )

Returns true if the input (considered as binary) is active (detection value is smaller than the specified threshold), and false otherwise.

Returns: either Y_ISPRESENT_FALSE or Y_ISPRESENT_TRUE, according to true if the input (considered as binary) is active (detection value is smaller than the specified threshold), and false otherwise

On failure, throws an exception or returns Y_ISPRESENT_INVALID.

Definition at line 205 of file yocto_proximity.cpp.

s64 YProximity::get_lastTimeApproached ( void )

Returns the number of elapsed milliseconds between the module power on and the last observed detection (the input contact transitioned from absent to present).

Returns: an integer corresponding to the number of elapsed milliseconds between the module power on and the last observed detection (the input contact transitioned from absent to present)

On failure, throws an exception or returns Y_LASTTIMEAPPROACHED_INVALID.

Definition at line 237 of file yocto_proximity.cpp.

s64 YProximity::get_lastTimeRemoved ( void )

Returns the number of elapsed milliseconds between the module power on and the last observed detection (the input contact transitioned from present to absent).

Returns: an integer corresponding to the number of elapsed milliseconds between the module power on and the last observed detection (the input contact transitioned from present to absent)

On failure, throws an exception or returns Y_LASTTIMEREMOVED_INVALID.

Definition at line 269 of file yocto_proximity.cpp.

Y_PROXIMITYREPORTMODE_enum YProximity::get_proximityReportMode ( void )

Returns the parameter (sensor value, presence or pulse count) returned by the get_currentValue function and callbacks.

Returns: a value among Y_PROXIMITYREPORTMODE_NUMERIC, Y_PROXIMITYREPORTMODE_PRESENCE and Y_PROXIMITYREPORTMODE_PULSECOUNT corresponding to the parameter (sensor value, presence or pulse count) returned by the get_currentValue function and callbacks

On failure, throws an exception or returns Y_PROXIMITYREPORTMODE_INVALID.

Definition at line 377 of file yocto_proximity.cpp.

s64 YProximity::get_pulseCounter ( void )

Returns the pulse counter value. The value is a 32 bit integer. In case of overflow (>=2^32), the counter will wrap. To reset the counter, just call the resetCounter() method.

Returns: an integer corresponding to the pulse counter value

On failure, throws an exception or returns Y_PULSECOUNTER_INVALID.

Definition at line 300 of file yocto_proximity.cpp.

s64 YProximity::get_pulseTimer ( void )

Returns the timer of the pulse counter (ms).

Returns: an integer corresponding to the timer of the pulse counter (ms)

On failure, throws an exception or returns Y_PULSETIMER_INVALID.

Definition at line 345 of file yocto_proximity.cpp.

double YProximity::get_signalValue ( void )

Returns the current value of signal measured by the proximity sensor.

Returns: a floating point number corresponding to the current value of signal measured by the proximity sensor

On failure, throws an exception or returns Y_SIGNALVALUE_INVALID.

Definition at line 114 of file yocto_proximity.cpp.

Y_ISPRESENT_enum YProximity::isPresent ( void )

inline

Definition at line 193 of file yocto_proximity.h.

s64 YProximity::lastTimeApproached ( void )

inline

Definition at line 208 of file yocto_proximity.h.

s64 YProximity::lastTimeRemoved ( void )

inline

Definition at line 223 of file yocto_proximity.h.

YProximity* YProximity::next ( void )

inline

Definition at line 371 of file yocto_proximity.h.

YProximity * YProximity::nextProximity ( void )

Continues the enumeration of proximity sensors started using yFirstProximity().

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

Definition at line 563 of file yocto_proximity.cpp.

Y_PROXIMITYREPORTMODE_enum YProximity::proximityReportMode ( void )

inline

Definition at line 268 of file yocto_proximity.h.

s64 YProximity::pulseCounter ( void )

inline

Definition at line 237 of file yocto_proximity.h.

s64 YProximity::pulseTimer ( void )

inline

Definition at line 253 of file yocto_proximity.h.

int YProximity::registerTimedReportCallback ( YProximityTimedReportCallback 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 528 of file yocto_proximity.cpp.

int YProximity::registerValueCallback ( YProximityValueCallback 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 488 of file yocto_proximity.cpp.

int YProximity::resetCounter ( void )

virtual

Resets the pulse counter value as well as its timer.

Returns: YAPI_SUCCESS if the call succeeds.

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

Definition at line 558 of file yocto_proximity.cpp.

int YProximity::set_detectionThreshold ( int newval )

Changes the threshold used to determine the logical state of the proximity sensor, when considered as a binary input (on/off).

Parameters

newval : an integer corresponding to the threshold used to determine the logical state of the proximity sensor, when considered as a binary input (on/off)

Returns: YAPI_SUCCESS if the call succeeds.

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

Definition at line 180 of file yocto_proximity.cpp.

int YProximity::set_proximityReportMode ( Y_PROXIMITYREPORTMODE_enum newval )

Changes the parameter type (sensor value, presence or pulse count) returned by the get_currentValue function and callbacks. The edge count value is limited to the 6 lowest digits. For values greater than one million, use get_pulseCounter().

Parameters

newval : a value among Y_PROXIMITYREPORTMODE_NUMERIC, Y_PROXIMITYREPORTMODE_PRESENCE and Y_PROXIMITYREPORTMODE_PULSECOUNT corresponding to the parameter type (sensor value, presence or pulse count) returned by the get_currentValue function and callbacks

Returns: YAPI_SUCCESS if the call succeeds.

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

Definition at line 413 of file yocto_proximity.cpp.

int YProximity::set_pulseCounter ( s64 newval )

Definition at line 322 of file yocto_proximity.cpp.

int YProximity::setDetectionThreshold ( int newval )

inline

Definition at line 179 of file yocto_proximity.h.

int YProximity::setProximityReportMode ( Y_PROXIMITYREPORTMODE_enum newval )

inline

Definition at line 286 of file yocto_proximity.h.

int YProximity::setPulseCounter ( s64 newval )

inline

Definition at line 241 of file yocto_proximity.h.

double YProximity::signalValue ( void )

inline

Definition at line 148 of file yocto_proximity.h.

Friends And Related Function Documentation

YProximity* yFindProximity ( const string & func )

friend

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

Returns: a YProximity object allowing you to drive the proximity sensor.

Definition at line 421 of file yocto_proximity.h.

YProximity* yFirstProximity ( void )

friend

Starts the enumeration of proximity sensors currently accessible. Use the method YProximity.nextProximity() to iterate on next proximity sensors.

Returns: a pointer to a YProximity object, corresponding to the first proximity sensor currently online, or a NULL pointer if there are none.

Definition at line 432 of file yocto_proximity.h.

Member Data Documentation

int YProximity::_detectionThreshold

protected

Definition at line 101 of file yocto_proximity.h.

Y_ISPRESENT_enum YProximity::_isPresent

protected

Definition at line 102 of file yocto_proximity.h.

s64 YProximity::_lastTimeApproached

protected

Definition at line 103 of file yocto_proximity.h.

s64 YProximity::_lastTimeRemoved

protected

Definition at line 104 of file yocto_proximity.h.

Y_PROXIMITYREPORTMODE_enum YProximity::_proximityReportMode

protected

Definition at line 107 of file yocto_proximity.h.

s64 YProximity::_pulseCounter

protected

Definition at line 105 of file yocto_proximity.h.

s64 YProximity::_pulseTimer

protected

Definition at line 106 of file yocto_proximity.h.

double YProximity::_signalValue

protected

Definition at line 100 of file yocto_proximity.h.

YProximityTimedReportCallback YProximity::_timedReportCallbackProximity

protected

Definition at line 109 of file yocto_proximity.h.

YProximityValueCallback YProximity::_valueCallbackProximity

protected

Definition at line 108 of file yocto_proximity.h.

const int YProximity::DETECTIONTHRESHOLD_INVALID = YAPI_INVALID_UINT

static

Definition at line 126 of file yocto_proximity.h.

const Y_ISPRESENT_enum YProximity::ISPRESENT_FALSE = Y_ISPRESENT_FALSE

static

Definition at line 127 of file yocto_proximity.h.

const Y_ISPRESENT_enum YProximity::ISPRESENT_INVALID = Y_ISPRESENT_INVALID

static

Definition at line 129 of file yocto_proximity.h.

const Y_ISPRESENT_enum YProximity::ISPRESENT_TRUE = Y_ISPRESENT_TRUE

static

Definition at line 128 of file yocto_proximity.h.

const s64 YProximity::LASTTIMEAPPROACHED_INVALID = YAPI_INVALID_LONG

static

Definition at line 130 of file yocto_proximity.h.

const s64 YProximity::LASTTIMEREMOVED_INVALID = YAPI_INVALID_LONG

static

Definition at line 131 of file yocto_proximity.h.

const Y_PROXIMITYREPORTMODE_enum YProximity::PROXIMITYREPORTMODE_INVALID = Y_PROXIMITYREPORTMODE_INVALID

static

Definition at line 137 of file yocto_proximity.h.

const Y_PROXIMITYREPORTMODE_enum YProximity::PROXIMITYREPORTMODE_NUMERIC = Y_PROXIMITYREPORTMODE_NUMERIC

static

Definition at line 134 of file yocto_proximity.h.

const Y_PROXIMITYREPORTMODE_enum YProximity::PROXIMITYREPORTMODE_PRESENCE = Y_PROXIMITYREPORTMODE_PRESENCE

static

Definition at line 135 of file yocto_proximity.h.

const Y_PROXIMITYREPORTMODE_enum YProximity::PROXIMITYREPORTMODE_PULSECOUNT = Y_PROXIMITYREPORTMODE_PULSECOUNT

static

Definition at line 136 of file yocto_proximity.h.

const s64 YProximity::PULSECOUNTER_INVALID = YAPI_INVALID_LONG

static

Definition at line 132 of file yocto_proximity.h.

const s64 YProximity::PULSETIMER_INVALID = YAPI_INVALID_LONG

static

Definition at line 133 of file yocto_proximity.h.

const double YProximity::SIGNALVALUE_INVALID = YAPI_INVALID_DOUBLE

static

Definition at line 125 of file yocto_proximity.h.

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

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