yocto_voltageoutput.h File Reference

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

Include dependency graph for yocto_voltageoutput.h:

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

Go to the source code of this file.

Classes
class	YVoltageOutput

Macros
#define	Y_CURRENTVOLTAGE_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_VOLTAGEATSTARTUP_INVALID   (YAPI_INVALID_DOUBLE)
#define	Y_VOLTAGETRANSITION_INVALID   (YAPI_INVALID_STRING)

Typedefs
typedef void(*	YVoltageOutputValueCallback) (YVoltageOutput *func, const string &functionValue)

Functions
YVoltageOutput *	yFindVoltageOutput (const string &func)
YVoltageOutput *	yFirstVoltageOutput (void)

Macro Definition Documentation

#define Y_CURRENTVOLTAGE_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 55 of file yocto_voltageoutput.h.

#define Y_VOLTAGEATSTARTUP_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 57 of file yocto_voltageoutput.h.

#define Y_VOLTAGETRANSITION_INVALID   (YAPI_INVALID_STRING)

Definition at line 56 of file yocto_voltageoutput.h.

Typedef Documentation

typedef void(* YVoltageOutputValueCallback) (YVoltageOutput *func, const string &functionValue)

Definition at line 54 of file yocto_voltageoutput.h.

Function Documentation

YVoltageOutput* yFindVoltageOutput ( const string &  func )

inline

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

Returns

a YVoltageOutput object allowing you to drive the voltage output.

Definition at line 276 of file yocto_voltageoutput.h.

YVoltageOutput* yFirstVoltageOutput ( void  )

inline

Starts the enumeration of voltage outputs currently accessible. Use the method YVoltageOutput.nextVoltageOutput() to iterate on next voltage outputs.

Returns

a pointer to a YVoltageOutput object, corresponding to the first voltage output currently online, or a NULL pointer if there are none.

Definition at line 287 of file yocto_voltageoutput.h.