yocto_buzzer.h File Reference

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

Include dependency graph for yocto_buzzer.h:

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

Go to the source code of this file.

Classes
class	YBuzzer

Macros
#define	Y_COMMAND_INVALID   (YAPI_INVALID_STRING)
#define	Y_FREQUENCY_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_PLAYSEQMAXSIZE_INVALID   (YAPI_INVALID_UINT)
#define	Y_PLAYSEQSIGNATURE_INVALID   (YAPI_INVALID_UINT)
#define	Y_PLAYSEQSIZE_INVALID   (YAPI_INVALID_UINT)
#define	Y_VOLUME_INVALID   (YAPI_INVALID_UINT)

Typedefs
typedef void(*	YBuzzerValueCallback) (YBuzzer *func, const string &functionValue)

Functions
YBuzzer *	yFindBuzzer (const string &func)
YBuzzer *	yFirstBuzzer (void)

Macro Definition Documentation

#define Y_COMMAND_INVALID   (YAPI_INVALID_STRING)

Definition at line 60 of file yocto_buzzer.h.

#define Y_FREQUENCY_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 55 of file yocto_buzzer.h.

#define Y_PLAYSEQMAXSIZE_INVALID   (YAPI_INVALID_UINT)

Definition at line 58 of file yocto_buzzer.h.

#define Y_PLAYSEQSIGNATURE_INVALID   (YAPI_INVALID_UINT)

Definition at line 59 of file yocto_buzzer.h.

#define Y_PLAYSEQSIZE_INVALID   (YAPI_INVALID_UINT)

Definition at line 57 of file yocto_buzzer.h.

#define Y_VOLUME_INVALID   (YAPI_INVALID_UINT)

Definition at line 56 of file yocto_buzzer.h.

Typedef Documentation

typedef void(* YBuzzerValueCallback) (YBuzzer *func, const string &functionValue)

Definition at line 54 of file yocto_buzzer.h.

Function Documentation

YBuzzer* yFindBuzzer ( const string &  func )

inline

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

Returns

a YBuzzer object allowing you to drive the buzzer.

Definition at line 449 of file yocto_buzzer.h.

YBuzzer* yFirstBuzzer ( void  )

inline

Starts the enumeration of buzzers currently accessible. Use the method YBuzzer.nextBuzzer() to iterate on next buzzers.

Returns

a pointer to a YBuzzer object, corresponding to the first buzzer currently online, or a NULL pointer if there are none.

Definition at line 460 of file yocto_buzzer.h.