yocto_anbutton.h File Reference

#include "yocto_api.h"
#include <cfloat>
#include <cmath>
#include <map>

Include dependency graph for yocto_anbutton.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	YAnButton

Macros
#define	_Y_ANALOGCALIBRATION_ENUM
#define	_Y_ISPRESSED_ENUM
#define	Y_CALIBRATEDVALUE_INVALID   (YAPI_INVALID_UINT)
#define	Y_CALIBRATIONMAX_INVALID   (YAPI_INVALID_UINT)
#define	Y_CALIBRATIONMIN_INVALID   (YAPI_INVALID_UINT)
#define	Y_LASTTIMEPRESSED_INVALID   (YAPI_INVALID_LONG)
#define	Y_LASTTIMERELEASED_INVALID   (YAPI_INVALID_LONG)
#define	Y_PULSECOUNTER_INVALID   (YAPI_INVALID_LONG)
#define	Y_PULSETIMER_INVALID   (YAPI_INVALID_LONG)
#define	Y_RAWVALUE_INVALID   (YAPI_INVALID_UINT)
#define	Y_SENSITIVITY_INVALID   (YAPI_INVALID_UINT)

Typedefs
typedef void(*	YAnButtonValueCallback) (YAnButton *func, const string &functionValue)

Enumerations
enum	Y_ANALOGCALIBRATION_enum { Y_ANALOGCALIBRATION_OFF = 0, Y_ANALOGCALIBRATION_ON = 1, Y_ANALOGCALIBRATION_INVALID = -1 }
enum	Y_ISPRESSED_enum { Y_ISPRESSED_FALSE = 0, Y_ISPRESSED_TRUE = 1, Y_ISPRESSED_INVALID = -1 }

Functions
YAnButton *	yFindAnButton (const string &func)
YAnButton *	yFirstAnButton (void)

Macro Definition Documentation

#define _Y_ANALOGCALIBRATION_ENUM

Definition at line 56 of file yocto_anbutton.h.

#define _Y_ISPRESSED_ENUM

Definition at line 64 of file yocto_anbutton.h.

#define Y_CALIBRATEDVALUE_INVALID   (YAPI_INVALID_UINT)

Definition at line 71 of file yocto_anbutton.h.

#define Y_CALIBRATIONMAX_INVALID   (YAPI_INVALID_UINT)

Definition at line 73 of file yocto_anbutton.h.

#define Y_CALIBRATIONMIN_INVALID   (YAPI_INVALID_UINT)

Definition at line 74 of file yocto_anbutton.h.

#define Y_LASTTIMEPRESSED_INVALID   (YAPI_INVALID_LONG)

Definition at line 76 of file yocto_anbutton.h.

#define Y_LASTTIMERELEASED_INVALID   (YAPI_INVALID_LONG)

Definition at line 77 of file yocto_anbutton.h.

#define Y_PULSECOUNTER_INVALID   (YAPI_INVALID_LONG)

Definition at line 78 of file yocto_anbutton.h.

#define Y_PULSETIMER_INVALID   (YAPI_INVALID_LONG)

Definition at line 79 of file yocto_anbutton.h.

#define Y_RAWVALUE_INVALID   (YAPI_INVALID_UINT)

Definition at line 72 of file yocto_anbutton.h.

#define Y_SENSITIVITY_INVALID   (YAPI_INVALID_UINT)

Definition at line 75 of file yocto_anbutton.h.

Typedef Documentation

typedef void(* YAnButtonValueCallback) (YAnButton *func, const string &functionValue)

Definition at line 54 of file yocto_anbutton.h.

Enumeration Type Documentation

enum Y_ANALOGCALIBRATION_enum

Enumerator
Y_ANALOGCALIBRATION_OFF
Y_ANALOGCALIBRATION_ON
Y_ANALOGCALIBRATION_INVALID

Definition at line 57 of file yocto_anbutton.h.

enum Y_ISPRESSED_enum

Enumerator
Y_ISPRESSED_FALSE
Y_ISPRESSED_TRUE
Y_ISPRESSED_INVALID

Definition at line 65 of file yocto_anbutton.h.

Function Documentation

YAnButton* yFindAnButton ( const string &  func )

inline

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

Returns

a YAnButton object allowing you to drive the analog input.

Definition at line 475 of file yocto_anbutton.h.

YAnButton* yFirstAnButton ( void  )

inline

Starts the enumeration of analog inputs currently accessible. Use the method YAnButton.nextAnButton() to iterate on next analog inputs.

Returns

a pointer to a YAnButton object, corresponding to the first analog input currently online, or a NULL pointer if there are none.

Definition at line 486 of file yocto_anbutton.h.