LinearConvertedValue< T > Class Template Reference

Brief description of class LinearConvertedValue. More...

#include <armarx/control/ethercat/LinearConvertedValue.h>

Public Member Functions

float getFactor () const
 
float getOffset () const
 
bool getOffsetBeforeFactor () const
 
T getRaw () const
 
void init (T *raw, const hardware_config::types::LinearConfig linearConfig, float defaultValue=std::nanf("1"), bool offsetBeforeFactor=true, const char *nameForDebugging="")
 init
 
void init (T *raw, float factor, float offset, float defaultValue=std::nanf("1"), bool offsetBeforeFactor=true, const char *nameForDebugging="")
 
 LinearConvertedValue ()
 
void read ()
 
void write ()
 

Public Attributes

float value
 

Detailed Description

template<typename T>
class armarx::control::ethercat::LinearConvertedValue< T >

Brief description of class LinearConvertedValue.

Detailed description of class LinearConvertedValue.

Definition at line 43 of file LinearConvertedValue.h.

Constructor & Destructor Documentation

◆ LinearConvertedValue()

template<typename T>
LinearConvertedValue ( )
inline

Definition at line 47 of file LinearConvertedValue.h.

Member Function Documentation

◆ getFactor()

template<typename T>
float getFactor ( ) const
inline

Definition at line 145 of file LinearConvertedValue.h.

◆ getOffset()

template<typename T>
float getOffset ( ) const
inline

Definition at line 151 of file LinearConvertedValue.h.

◆ getOffsetBeforeFactor()

template<typename T>
bool getOffsetBeforeFactor ( ) const
inline

Definition at line 157 of file LinearConvertedValue.h.

◆ getRaw()

template<typename T>
T getRaw ( ) const
inline

Definition at line 139 of file LinearConvertedValue.h.

◆ init() [1/2]

template<typename T>
void init ( T * raw,
const hardware_config::types::LinearConfig linearConfig,
float defaultValue = std::nanf("1"),
bool offsetBeforeFactor = true,
const char * nameForDebugging = "" )
inline

init

Parameters
raw
node
defaultValue
offsetBeforeFactorif true the offset is added before multiplying with factor. If false: the other way around.
nameForDebuggingThis name is printend in case an error is encountered (Its only purpose is to ease debugging)

Definition at line 63 of file LinearConvertedValue.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ init() [2/2]

template<typename T>
void init ( T * raw,
float factor,
float offset,
float defaultValue = std::nanf("1"),
bool offsetBeforeFactor = true,
const char * nameForDebugging = "" )
inline

Definition at line 78 of file LinearConvertedValue.h.

+ Here is the call graph for this function:

◆ read()

template<typename T>
void read ( )
inline

Definition at line 111 of file LinearConvertedValue.h.

+ Here is the caller graph for this function:

◆ write()

template<typename T>
void write ( )
inline

Definition at line 124 of file LinearConvertedValue.h.

+ Here is the caller graph for this function:

Member Data Documentation

◆ value

template<typename T>
float value

Definition at line 136 of file LinearConvertedValue.h.


The documentation for this class was generated from the following file: