yocto_poweroutput.h File Reference

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

Include dependency graph for yocto_poweroutput.h:

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

Go to the source code of this file.

Classes
class	YPowerOutput

Macros
#define	_Y_VOLTAGE_ENUM

Typedefs
typedef void(*	YPowerOutputValueCallback) (YPowerOutput *func, const string &functionValue)

Enumerations
enum	Y_VOLTAGE_enum { Y_VOLTAGE_OFF = 0, Y_VOLTAGE_OUT3V3 = 1, Y_VOLTAGE_OUT5V = 2, Y_VOLTAGE_INVALID = -1 }

Functions
YPowerOutput *	yFindPowerOutput (const string &func)
YPowerOutput *	yFirstPowerOutput (void)

Macro Definition Documentation

#define _Y_VOLTAGE_ENUM

Definition at line 56 of file yocto_poweroutput.h.

Typedef Documentation

typedef void(* YPowerOutputValueCallback) (YPowerOutput *func, const string &functionValue)

Definition at line 54 of file yocto_poweroutput.h.

Enumeration Type Documentation

enum Y_VOLTAGE_enum

Enumerator
Y_VOLTAGE_OFF
Y_VOLTAGE_OUT3V3
Y_VOLTAGE_OUT5V
Y_VOLTAGE_INVALID

Definition at line 57 of file yocto_poweroutput.h.

Function Documentation

YPowerOutput* yFindPowerOutput ( const string &  func )

inline

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

Returns

a YPowerOutput object allowing you to drive the power ouput control.

Definition at line 240 of file yocto_poweroutput.h.

YPowerOutput* yFirstPowerOutput ( void  )

inline

Starts the enumeration of dual power ouput controls currently accessible. Use the method YPowerOutput.nextPowerOutput() to iterate on next dual power ouput controls.

Returns

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

Definition at line 251 of file yocto_poweroutput.h.