yocto_current.h File Reference

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

Include dependency graph for yocto_current.h:

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

Go to the source code of this file.

Classes
class	YCurrent

Macros
#define	_Y_ENABLED_ENUM

Typedefs
typedef void(*	YCurrentTimedReportCallback) (YCurrent *func, YMeasure measure)
typedef void(*	YCurrentValueCallback) (YCurrent *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 }

Functions
YCurrent *	yFindCurrent (const string &func)
YCurrent *	yFirstCurrent (void)

Macro Definition Documentation

#define _Y_ENABLED_ENUM

Definition at line 58 of file yocto_current.h.

Typedef Documentation

typedef void(* YCurrentTimedReportCallback) (YCurrent *func, YMeasure measure)

Definition at line 56 of file yocto_current.h.

typedef void(* YCurrentValueCallback) (YCurrent *func, const string &functionValue)

Definition at line 54 of file yocto_current.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 59 of file yocto_current.h.

Function Documentation

YCurrent* yFindCurrent ( const string &  func )

inline

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

Returns

a YCurrent object allowing you to drive the current sensor.

Definition at line 237 of file yocto_current.h.

YCurrent* yFirstCurrent ( void  )

inline

Starts the enumeration of current sensors currently accessible. Use the method YCurrent.nextCurrent() to iterate on next current sensors.

Returns

a pointer to a YCurrent object, corresponding to the first current sensor currently online, or a NULL pointer if there are none.

Definition at line 248 of file yocto_current.h.