yocto_pwmpowersource.h File Reference

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

Include dependency graph for yocto_pwmpowersource.h:

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

Go to the source code of this file.

Classes
class	YPwmPowerSource

Macros
#define	_Y_POWERMODE_ENUM

Typedefs
typedef void(*	YPwmPowerSourceValueCallback) (YPwmPowerSource *func, const string &functionValue)

Enumerations
enum	Y_POWERMODE_enum {   Y_POWERMODE_USB_5V = 0, Y_POWERMODE_USB_3V = 1, Y_POWERMODE_EXT_V = 2, Y_POWERMODE_OPNDRN = 3,   Y_POWERMODE_INVALID = -1 }

Functions
YPwmPowerSource *	yFindPwmPowerSource (const string &func)
YPwmPowerSource *	yFirstPwmPowerSource (void)

Macro Definition Documentation

#define _Y_POWERMODE_ENUM

Definition at line 56 of file yocto_pwmpowersource.h.

Typedef Documentation

typedef void(* YPwmPowerSourceValueCallback) (YPwmPowerSource *func, const string &functionValue)

Definition at line 54 of file yocto_pwmpowersource.h.

Enumeration Type Documentation

enum Y_POWERMODE_enum

Enumerator
Y_POWERMODE_USB_5V
Y_POWERMODE_USB_3V
Y_POWERMODE_EXT_V
Y_POWERMODE_OPNDRN
Y_POWERMODE_INVALID

Definition at line 57 of file yocto_pwmpowersource.h.

Function Documentation

YPwmPowerSource* yFindPwmPowerSource ( const string &  func )

inline

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

Returns

a YPwmPowerSource object allowing you to drive the voltage source.

Definition at line 245 of file yocto_pwmpowersource.h.

YPwmPowerSource* yFirstPwmPowerSource ( void  )

inline

Starts the enumeration of Voltage sources currently accessible. Use the method YPwmPowerSource.nextPwmPowerSource() to iterate on next Voltage sources.

Returns

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

Definition at line 256 of file yocto_pwmpowersource.h.