yocto_power.h File Reference

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

Include dependency graph for yocto_power.h:

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

Go to the source code of this file.

Classes
class	YPower

Macros
#define	Y_COSPHI_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_METER_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_METERTIMER_INVALID   (YAPI_INVALID_UINT)

Typedefs
typedef void(*	YPowerTimedReportCallback) (YPower *func, YMeasure measure)
typedef void(*	YPowerValueCallback) (YPower *func, const string &functionValue)

Functions
YPower *	yFindPower (const string &func)
YPower *	yFirstPower (void)

Macro Definition Documentation

#define Y_COSPHI_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 57 of file yocto_power.h.

#define Y_METER_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 58 of file yocto_power.h.

#define Y_METERTIMER_INVALID   (YAPI_INVALID_UINT)

Definition at line 59 of file yocto_power.h.

Typedef Documentation

typedef void(* YPowerTimedReportCallback) (YPower *func, YMeasure measure)

Definition at line 56 of file yocto_power.h.

typedef void(* YPowerValueCallback) (YPower *func, const string &functionValue)

Definition at line 54 of file yocto_power.h.

Function Documentation

YPower* yFindPower ( const string &  func )

inline

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

Returns

a YPower object allowing you to drive the electrical power sensor.

Definition at line 279 of file yocto_power.h.

YPower* yFirstPower ( void  )

inline

Starts the enumeration of electrical power sensors currently accessible. Use the method YPower.nextPower() to iterate on next electrical power sensors.

Returns

a pointer to a YPower object, corresponding to the first electrical power sensor currently online, or a NULL pointer if there are none.

Definition at line 290 of file yocto_power.h.