libvisiontransfer  7.0.0
Classes | Public Types | Public Member Functions | List of all members
visiontransfer::ParameterInfo Class Reference

Classes

union  ParameterValue
 
class  Pimpl
 

Public Types

enum  ParameterType { TYPE_INT = 1, TYPE_DOUBLE = 2, TYPE_BOOL = 3 }
 

Public Member Functions

std::string getName () const
 Returns the string representation of the parameter name. More...
 
ParameterType getType () const
 Returns the type of the parameter. More...
 
bool isWriteable () const
 Returns whether the parameter is writeable (or read-only) More...
 
template<typename T >
getValue () const
 Returns the current parameter value, cast to the desired type (int, double or bool) More...
 
template<typename T >
getMin () const
 Returns the minimum parameter value, cast to the desired type (int, double or bool) More...
 
template<typename T >
getMax () const
 Returns the maximum parameter value, cast to the desired type (int, double or bool) More...
 
template<typename T >
getInc () const
 Returns the increment of the parameter (i.e. increment for raising / lowering the value), cast to the desired type (int, double or bool) More...
 

Detailed Description

Definition at line 24 of file parameterinfo.h.

Member Function Documentation

◆ getInc()

template<typename T >
T visiontransfer::ParameterInfo::getInc ( ) const

Returns the increment of the parameter (i.e. increment for raising / lowering the value), cast to the desired type (int, double or bool)

◆ getMax()

template<typename T >
T visiontransfer::ParameterInfo::getMax ( ) const

Returns the maximum parameter value, cast to the desired type (int, double or bool)

◆ getMin()

template<typename T >
T visiontransfer::ParameterInfo::getMin ( ) const

Returns the minimum parameter value, cast to the desired type (int, double or bool)

◆ getName()

std::string visiontransfer::ParameterInfo::getName ( ) const

Returns the string representation of the parameter name.

Definition at line 134 of file parameterinfo.cpp.

◆ getType()

ParameterInfo::ParameterType visiontransfer::ParameterInfo::getType ( ) const

Returns the type of the parameter.

Definition at line 135 of file parameterinfo.cpp.

◆ getValue()

template<typename T >
T visiontransfer::ParameterInfo::getValue ( ) const

Returns the current parameter value, cast to the desired type (int, double or bool)

◆ isWriteable()

bool visiontransfer::ParameterInfo::isWriteable ( ) const

Returns whether the parameter is writeable (or read-only)

Definition at line 136 of file parameterinfo.cpp.


The documentation for this class was generated from the following files:
Nerian Vision Technologies