yocto_quadraturedecoder.h File Reference

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

Include dependency graph for yocto_quadraturedecoder.h:

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

Go to the source code of this file.

Classes
class	YQuadratureDecoder

Macros
#define	_Y_DECODING_ENUM
#define	Y_SPEED_INVALID   (YAPI_INVALID_DOUBLE)

Typedefs
typedef void(*	YQuadratureDecoderTimedReportCallback) (YQuadratureDecoder *func, YMeasure measure)
typedef void(*	YQuadratureDecoderValueCallback) (YQuadratureDecoder *func, const string &functionValue)

Enumerations
enum	Y_DECODING_enum { Y_DECODING_OFF = 0, Y_DECODING_ON = 1, Y_DECODING_INVALID = -1 }

Functions
YQuadratureDecoder *	yFindQuadratureDecoder (const string &func)
YQuadratureDecoder *	yFirstQuadratureDecoder (void)

Macro Definition Documentation

#define _Y_DECODING_ENUM

Definition at line 58 of file yocto_quadraturedecoder.h.

#define Y_SPEED_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 65 of file yocto_quadraturedecoder.h.

Typedef Documentation

typedef void(* YQuadratureDecoderTimedReportCallback) (YQuadratureDecoder *func, YMeasure measure)

Definition at line 56 of file yocto_quadraturedecoder.h.

typedef void(* YQuadratureDecoderValueCallback) (YQuadratureDecoder *func, const string &functionValue)

Definition at line 54 of file yocto_quadraturedecoder.h.

Enumeration Type Documentation

enum Y_DECODING_enum

Enumerator
Y_DECODING_OFF
Y_DECODING_ON
Y_DECODING_INVALID

Definition at line 59 of file yocto_quadraturedecoder.h.

Function Documentation

YQuadratureDecoder* yFindQuadratureDecoder ( const string &  func )

inline

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

Returns

a YQuadratureDecoder object allowing you to drive the quadrature decoder.

Definition at line 284 of file yocto_quadraturedecoder.h.

YQuadratureDecoder* yFirstQuadratureDecoder ( void  )

inline

Starts the enumeration of quadrature decoders currently accessible. Use the method YQuadratureDecoder.nextQuadratureDecoder() to iterate on next quadrature decoders.

Returns

a pointer to a YQuadratureDecoder object, corresponding to the first quadrature decoder currently online, or a NULL pointer if there are none.

Definition at line 295 of file yocto_quadraturedecoder.h.