RTXI  3.0.0
The Real-Time eXperiment Interface Reference Manual
Data Structures | Typedefs | Enumerations | Functions | Variables
Widgets::Variable Namespace Reference

Data Structures

struct  Info
 

Typedefs

typedef size_t Id
 

Enumerations

enum  variable_t : size_t {
  INT_PARAMETER = 0 , DOUBLE_PARAMETER , UINT_PARAMETER , STATE ,
  COMMENT , UNKNOWN
}
 

Functions

std::string state2string (RT::State::state_t state)
 
std::string vartype2string (variable_t type)
 

Variables

constexpr Id INVALID_ID = static_cast<Id>(std::numeric_limits<size_t>::max())
 

Detailed Description

variable and state structures about constants and parameters

Typedef Documentation

◆ Id

typedef size_t Widgets::Variable::Id

Definition at line 47 of file widgets.hpp.

Enumeration Type Documentation

◆ variable_t

Code description of the variable type used for the parameter

Enumerator
INT_PARAMETER 
DOUBLE_PARAMETER 
UINT_PARAMETER 
STATE 
COMMENT 
UNKNOWN 

Definition at line 53 of file widgets.hpp.

Function Documentation

◆ state2string()

std::string Widgets::Variable::state2string(RT::State::state_t state)

Converts state code to human readable string

Parameters
codethe state code to convert
Returns
A string describing the code

Definition at line 22 of file widgets.cpp.

◆ vartype2string()

std::string Widgets::Variable::vartype2string(variable_t type)

Converts variable type to human readable string

Parameters
codethe variable type code to convert
Returns
A string describing the code

Definition at line 51 of file widgets.cpp.

Variable Documentation

◆ INVALID_ID

constexpr Id Widgets::Variable::INVALID_ID = static_cast<Id>(std::numeric_limits<size_t>::max())
constexpr

Definition at line 48 of file widgets.hpp.