Classes | Macros | Typedefs | Enumerations | Functions
yocto_currentloopoutput.h File Reference
#include "yocto_api.h"
#include <cfloat>
#include <cmath>
#include <map>
Include dependency graph for yocto_currentloopoutput.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  YCurrentLoopOutput
 

Macros

#define _Y_LOOPPOWER_ENUM
 
#define Y_CURRENT_INVALID   (YAPI_INVALID_DOUBLE)
 
#define Y_CURRENTATSTARTUP_INVALID   (YAPI_INVALID_DOUBLE)
 
#define Y_CURRENTTRANSITION_INVALID   (YAPI_INVALID_STRING)
 

Typedefs

typedef void(* YCurrentLoopOutputValueCallback) (YCurrentLoopOutput *func, const string &functionValue)
 

Enumerations

enum  Y_LOOPPOWER_enum { Y_LOOPPOWER_NOPWR = 0, Y_LOOPPOWER_LOWPWR = 1, Y_LOOPPOWER_POWEROK = 2, Y_LOOPPOWER_INVALID = -1 }
 

Functions

YCurrentLoopOutputyFindCurrentLoopOutput (const string &func)
 
YCurrentLoopOutputyFirstCurrentLoopOutput (void)
 

Macro Definition Documentation

#define _Y_LOOPPOWER_ENUM

Definition at line 56 of file yocto_currentloopoutput.h.

#define Y_CURRENT_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 64 of file yocto_currentloopoutput.h.

#define Y_CURRENTATSTARTUP_INVALID   (YAPI_INVALID_DOUBLE)

Definition at line 66 of file yocto_currentloopoutput.h.

#define Y_CURRENTTRANSITION_INVALID   (YAPI_INVALID_STRING)

Definition at line 65 of file yocto_currentloopoutput.h.

Typedef Documentation

typedef void(* YCurrentLoopOutputValueCallback) (YCurrentLoopOutput *func, const string &functionValue)

Definition at line 54 of file yocto_currentloopoutput.h.

Enumeration Type Documentation

Enumerator
Y_LOOPPOWER_NOPWR 
Y_LOOPPOWER_LOWPWR 
Y_LOOPPOWER_POWEROK 
Y_LOOPPOWER_INVALID 

Definition at line 57 of file yocto_currentloopoutput.h.

Function Documentation

YCurrentLoopOutput* yFindCurrentLoopOutput ( const string &  func)
inline

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

Definition at line 308 of file yocto_currentloopoutput.h.

YCurrentLoopOutput* yFirstCurrentLoopOutput ( void  )
inline

Starts the enumeration of 4-20mA outputs currently accessible. Use the method YCurrentLoopOutput.nextCurrentLoopOutput() to iterate on next 4-20mA outputs.

Returns
a pointer to a YCurrentLoopOutput object, corresponding to the first 4-20mA output currently online, or a NULL pointer if there are none.

Definition at line 319 of file yocto_currentloopoutput.h.



yoctopuce_altimeter
Author(s): Anja Sheppard
autogenerated on Mon Jun 10 2019 15:49:13