yocto_dualpower.h File Reference

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

Include dependency graph for yocto_dualpower.h:

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

Go to the source code of this file.

Classes
class	YDualPower

Macros
#define	_Y_POWERCONTROL_ENUM
#define	_Y_POWERSTATE_ENUM
#define	Y_EXTVOLTAGE_INVALID   (YAPI_INVALID_UINT)

Typedefs
typedef void(*	YDualPowerValueCallback) (YDualPower *func, const string &functionValue)

Enumerations
enum	Y_POWERCONTROL_enum {   Y_POWERCONTROL_AUTO = 0, Y_POWERCONTROL_FROM_USB = 1, Y_POWERCONTROL_FROM_EXT = 2, Y_POWERCONTROL_OFF = 3,   Y_POWERCONTROL_INVALID = -1 }
enum	Y_POWERSTATE_enum { Y_POWERSTATE_OFF = 0, Y_POWERSTATE_FROM_USB = 1, Y_POWERSTATE_FROM_EXT = 2, Y_POWERSTATE_INVALID = -1 }

Functions
YDualPower *	yFindDualPower (const string &func)
YDualPower *	yFirstDualPower (void)

Macro Definition Documentation

#define _Y_POWERCONTROL_ENUM

Definition at line 65 of file yocto_dualpower.h.

#define _Y_POWERSTATE_ENUM

Definition at line 56 of file yocto_dualpower.h.

#define Y_EXTVOLTAGE_INVALID   (YAPI_INVALID_UINT)

Definition at line 74 of file yocto_dualpower.h.

Typedef Documentation

typedef void(* YDualPowerValueCallback) (YDualPower *func, const string &functionValue)

Definition at line 54 of file yocto_dualpower.h.

Enumeration Type Documentation

enum Y_POWERCONTROL_enum

Enumerator
Y_POWERCONTROL_AUTO
Y_POWERCONTROL_FROM_USB
Y_POWERCONTROL_FROM_EXT
Y_POWERCONTROL_OFF
Y_POWERCONTROL_INVALID

Definition at line 66 of file yocto_dualpower.h.

enum Y_POWERSTATE_enum

Enumerator
Y_POWERSTATE_OFF
Y_POWERSTATE_FROM_USB
Y_POWERSTATE_FROM_EXT
Y_POWERSTATE_INVALID

Definition at line 57 of file yocto_dualpower.h.

Function Documentation

YDualPower* yFindDualPower ( const string &  func )

inline

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

Returns

a YDualPower object allowing you to drive the power control.

Definition at line 285 of file yocto_dualpower.h.

YDualPower* yFirstDualPower ( void  )

inline

Starts the enumeration of dual power controls currently accessible. Use the method YDualPower.nextDualPower() to iterate on next dual power controls.

Returns

a pointer to a YDualPower object, corresponding to the first dual power control currently online, or a NULL pointer if there are none.

Definition at line 296 of file yocto_dualpower.h.