yocto_pwmoutput.h File Reference

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

Include dependency graph for yocto_pwmoutput.h:

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

Go to the source code of this file.

Classes
class	YPwmOutput

Macros
#define	_Y_ENABLED_ENUM
#define	_Y_ENABLEDATPOWERON_ENUM
#define	Y_DUTYCYCLE_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_DUTYCYCLEATPOWERON_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_FREQUENCY_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_PERIOD_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_PULSEDURATION_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_PWMTRANSITION_INVALID   (YAPI_INVALID_STRING)

Typedefs
typedef void(*	YPwmOutputValueCallback) (YPwmOutput *func, const string &functionValue)

Enumerations
enum	Y_ENABLED_enum {   Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1, Y_ENABLED_FALSE = 0,   Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1, Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1,   Y_ENABLED_INVALID = -1, Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1,   Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1, Y_ENABLED_FALSE = 0,   Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1 }
enum	Y_ENABLEDATPOWERON_enum {   Y_ENABLEDATPOWERON_FALSE = 0, Y_ENABLEDATPOWERON_TRUE = 1, Y_ENABLEDATPOWERON_INVALID = -1, Y_ENABLEDATPOWERON_FALSE = 0,   Y_ENABLEDATPOWERON_TRUE = 1, Y_ENABLEDATPOWERON_INVALID = -1 }

Functions
YPwmOutput *	yFindPwmOutput (const string &func)
YPwmOutput *	yFirstPwmOutput (void)

Macro Definition Documentation

#define _Y_ENABLED_ENUM

Definition at line 56 of file yocto_pwmoutput.h.

#define _Y_ENABLEDATPOWERON_ENUM

Definition at line 64 of file yocto_pwmoutput.h.

#define Y_DUTYCYCLE_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 73 of file yocto_pwmoutput.h.

#define Y_DUTYCYCLEATPOWERON_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 76 of file yocto_pwmoutput.h.

#define Y_FREQUENCY_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 71 of file yocto_pwmoutput.h.

#define Y_PERIOD_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 72 of file yocto_pwmoutput.h.

#define Y_PULSEDURATION_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 74 of file yocto_pwmoutput.h.

#define Y_PWMTRANSITION_INVALID   (YAPI_INVALID_STRING)

Definition at line 75 of file yocto_pwmoutput.h.

Typedef Documentation

typedef void(* YPwmOutputValueCallback) (YPwmOutput *func, const string &functionValue)

Definition at line 54 of file yocto_pwmoutput.h.

Enumeration Type Documentation

enum Y_ENABLED_enum

Enumerator
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID
Y_ENABLED_FALSE
Y_ENABLED_TRUE
Y_ENABLED_INVALID

Definition at line 57 of file yocto_pwmoutput.h.

enum Y_ENABLEDATPOWERON_enum

Enumerator
Y_ENABLEDATPOWERON_FALSE
Y_ENABLEDATPOWERON_TRUE
Y_ENABLEDATPOWERON_INVALID
Y_ENABLEDATPOWERON_FALSE
Y_ENABLEDATPOWERON_TRUE
Y_ENABLEDATPOWERON_INVALID

Definition at line 65 of file yocto_pwmoutput.h.

Function Documentation

YPwmOutput* yFindPwmOutput ( const string &  func )

inline

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

Returns

a YPwmOutput object allowing you to drive the PWM.

Definition at line 456 of file yocto_pwmoutput.h.

YPwmOutput* yFirstPwmOutput ( void  )

inline

Starts the enumeration of PWMs currently accessible. Use the method YPwmOutput.nextPwmOutput() to iterate on next PWMs.

Returns

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

Definition at line 467 of file yocto_pwmoutput.h.