THM1176InstrumentDriver 1.1
C++ API for Metrolab THM1176
Loading...
Searching...
No Matches
MTL::Instrument::THM1176Types::sBoundedParm< DataType > Struct Template Reference

Parameter template, with current/min/max/default values. More...

#include <THM1176Types.h>

Public Member Functions

 sBoundedParm (DataType Val=0, DataType Min=0, DataType Max=0, DataType Def=0)
 Constructor.
 
void clear (void)
 Clear the parameter to default values.
 
bool operator== (sBoundedParm other) const
 Equality operator.
 
bool operator!= (sBoundedParm other) const
 Inequality operator.
 
sBoundedParmoperator= (const DataType &scalar)
 Set value, min, max and default to given value.
 

Public Attributes

DataType Val {}
 Current value.
 
DataType Min {}
 Lower bound.
 
DataType Max {}
 Upper bound.
 
DataType Def {}
 Default value.
 

Detailed Description

template<class DataType>
struct MTL::Instrument::THM1176Types::sBoundedParm< DataType >

Parameter template, with current/min/max/default values.

Template Parameters
DataTypeParameter's data type (e.g. I32 or F32).

Definition at line 245 of file THM1176Types.h.

Constructor & Destructor Documentation

◆ sBoundedParm()

template<class DataType>
MTL::Instrument::THM1176Types::sBoundedParm< DataType >::sBoundedParm ( DataType Val = 0,
DataType Min = 0,
DataType Max = 0,
DataType Def = 0 )
inline

Constructor.

Parameters
[in]ValCurrent value.
[in]MinLower bound.
[in]MaxUpper bound.
[in]DefDefault value.

Definition at line 258 of file THM1176Types.h.

Member Function Documentation

◆ clear()

template<class DataType>
void MTL::Instrument::THM1176Types::sBoundedParm< DataType >::clear ( void )
inline

Clear the parameter to default values.

Definition at line 261 of file THM1176Types.h.

◆ operator!=()

template<class DataType>
bool MTL::Instrument::THM1176Types::sBoundedParm< DataType >::operator!= ( sBoundedParm< DataType > other) const
inline

Inequality operator.

Definition at line 277 of file THM1176Types.h.

◆ operator=()

template<class DataType>
sBoundedParm & MTL::Instrument::THM1176Types::sBoundedParm< DataType >::operator= ( const DataType & scalar)
inline

Set value, min, max and default to given value.

Definition at line 281 of file THM1176Types.h.

◆ operator==()

template<class DataType>
bool MTL::Instrument::THM1176Types::sBoundedParm< DataType >::operator== ( sBoundedParm< DataType > other) const
inline

Equality operator.

Definition at line 268 of file THM1176Types.h.

Member Data Documentation

◆ Def

template<class DataType>
DataType MTL::Instrument::THM1176Types::sBoundedParm< DataType >::Def {}

Default value.

Definition at line 250 of file THM1176Types.h.

◆ Max

template<class DataType>
DataType MTL::Instrument::THM1176Types::sBoundedParm< DataType >::Max {}

Upper bound.

Definition at line 249 of file THM1176Types.h.

◆ Min

template<class DataType>
DataType MTL::Instrument::THM1176Types::sBoundedParm< DataType >::Min {}

Lower bound.

Definition at line 248 of file THM1176Types.h.

◆ Val

template<class DataType>
DataType MTL::Instrument::THM1176Types::sBoundedParm< DataType >::Val {}

Current value.

Definition at line 247 of file THM1176Types.h.


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