sf::VariableTypes::Definition Struct Reference

Structure used to set up a variable The method Variable::getDefinition() transforms the definition string into this structure. More...

#include <VariableTypes.h>

Collaboration diagram for sf::VariableTypes::Definition:

Public Attributes
bool	_valid {false}
	Flag indicating this structure is valid.
id_type	_id {0}
	The id of the new global instance.
std::string	_name
	Name path separated using '|' characters.
flags_type	_flags {0}
	Combination of EFlag flags.
std::string	_description
	Description of the instance without comma's.
std::string	_unit
	unit preferably in SI units so conversion and calculations are simple. Also used to Set the string filter type.
std::string	_convertOption
	Additional option used during conversion. (not used yet)
Value::EType	_type
	Internal type of the instance.
Value	_roundValue
	Rounding value. The value is a multiple of this value.
Value	_defaultValue
	This is the value this instance starts with.
Value	_minValue
	Minimum limit of this instance. When the min and max limits are zero no limits are applied.
Value	_maxValue
	Maximum limit of this instance. When the min and max limits are zero no limits are applied.
State::Vector	_states
	A vector of VariableTypes::State` instances.

Detailed Description

Structure used to set up a variable The method Variable::getDefinition() transforms the definition string into this structure.

Member Data Documentation

_convertOption

std::string sf::VariableTypes::Definition::_convertOption

Additional option used during conversion. (not used yet)

_defaultValue

Value sf::VariableTypes::Definition::_defaultValue

This is the value this instance starts with.

_description

std::string sf::VariableTypes::Definition::_description

Description of the instance without comma's.

_flags

flags_type sf::VariableTypes::Definition::_flags {0}

Combination of EFlag flags.

_id

id_type sf::VariableTypes::Definition::_id {0}

The id of the new global instance.

_maxValue

Value sf::VariableTypes::Definition::_maxValue

Maximum limit of this instance.
When the min and max limits are zero no limits are applied.

_minValue

Value sf::VariableTypes::Definition::_minValue

Minimum limit of this instance.
When the min and max limits are zero no limits are applied.

_name

std::string sf::VariableTypes::Definition::_name

Name path separated using '|' characters.

_roundValue

Value sf::VariableTypes::Definition::_roundValue

Rounding value. The value is a multiple of this value.

_states

State::Vector sf::VariableTypes::Definition::_states

A vector of VariableTypes::State` instances.

_type

Value::EType sf::VariableTypes::Definition::_type

Internal type of the instance.

_unit

std::string sf::VariableTypes::Definition::_unit

unit preferably in SI units so conversion and calculations are simple.
Also used to Set the string filter type.

_valid

bool sf::VariableTypes::Definition::_valid {false}

Flag indicating this structure is valid.

---

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

• VariableTypes.h