sf::VariableReference Struct Reference

#include <VariableReference.h>

Inheritance diagram for sf::VariableReference:

Collaboration diagram for sf::VariableReference:

Public Member Functions
	VariableReference (bool global)
	Constructor when global is true the reference is added to the global list.
	~VariableReference ()
	Destructor.
void	copy (const VariableReference &ref)
	Copies the members to this instance except for the list and global members.

Public Attributes
bool	_global {false}
bool	_exported {false}
bool	_valid {false}
id_type	_id {0}
flags_type	_flags {0}
flags_type	_curFlags {0}
Value::EType	_type {Value::vitUndefined}
std::string	_name
std::string	_description
std::string	_unit
Value	_curValue
Value	_defValue
Value	_maxValue
Value	_minValue
Value	_rndValue
int	_sigDigits {0}
State::Vector	_states
PtrVector	_list
int	_localActive {0}
std::string	_convertOption
std::string	_convertUnit
Value	_convertCurValue
Value	_convertDefValue
Value	_convertMaxValue
Value	_convertMinValue
Value	_convertRndValue
int	_convertSigDigits {0}
Value	_convertMultiplier
Value	_convertOffset

Additional Inherited Members
Public Types inherited from sf::VariableTypes
enum	EEvent : int {   veConvert = 64000 , veNewId = -32000 , veUserGlobal , veFirstLocal = 0 ,   veFlagsChange = 1 , veValueChange = 2 , veInvalid = 3 , veConverted = 4 ,   veUserLocal = 5 , veFirstPrivate = 16000 , veIdChanged = 16001 , veDesiredId = 16002 ,   veRemove = 16003 , veGetOwner = 16004 , veLostOwner = 16005 , veLinked = 16006 ,   veUnlinked = 16007 , veSetup = 16008 , veUserPrivate = 16009 }
	Events sent to the handler set with #setHandler. More...
enum	EField : int {   vfId = 0 , vfName , vfUnit , vfFlags ,   vfDescription , vfType , vfConversionType , vfRound ,   vfDefault , vfMinimum , vfMaximum , vfFirstState }
	Enumeration of the fields order in the setup string. More...
enum	EFlag : flags_type {   flgReadonly = 1 << 0 , flgArchive = 1 << 1 , flgShare = 1 << 2 , flgLink = 1 << 3 ,   flgFunction = 1 << 4 , flgParameter = 1 << 5 , flgHidden = 1 << 6 , flgExport = 1 << 7 ,   flgWriteable = 1 << 8 }
	Enumeration type for specifying flags. More...
enum	EStringType : int {   stNormal = 0 , stMulti , stPath , stDirectory ,   stFilename , stSubdirectory }
	Enumeration of string types used for filtering. More...
typedef TVector< Variable * >	PtrVector
	Vector for pointers to variables.
typedef TVector< Variable >	Vector
	Vector for instances of variables.
typedef TVector< VariableReference * >	ReferenceVector
	Types for internal use.
Public Types inherited from sf::InformationTypes
typedef unsigned long long	id_type
	Type used for the identifying integer (64-bits).
typedef int32_t	flags_type
	Type used for the flag integer.
typedef size_t	size_type
	Type used for size of vectors.
typedef ssize_t	ssize_type
	Same as size_type but a signed version.
typedef uintptr_t	data_type
	Type used for containing a single data element which is the largest integer.
typedef intptr_t	sdata_type
	Type used for containing a single data element which is the largest signed integer.
typedef TVector< id_type >	IdVector
	Vector for lists of information ID's.
typedef TVector< InformationBase * >	Vector
	Vector for containing different information base derived classes.
Static Public Member Functions inherited from sf::InformationTypes
template<typename T >
static constexpr std::enable_if_t<(sizeof(T)<=sizeof(data_type)), data_type >	toDataType (T value)
	Casts any type to a data_type value.
template<typename T >
static constexpr std::enable_if_t<(sizeof(T)<=sizeof(data_type)||std::is_reference_v< T >), T >	fromDataType (data_type value)
	Casts a data_type value to a given type. Reference types are also possible since they are the same size as a pointer underwater.
Static Public Attributes inherited from sf::InformationTypes
static constexpr size_t	npos = std::numeric_limits<size_type>::max()
	Unsigned size value indicating not found or no index.

Detailed Description

Class referenced by the Variable class which carries the actual data. This type is never directly used.

Constructor & Destructor Documentation

VariableReference()

sf::VariableReference::VariableReference ( bool  global )

explicit

Constructor when global is true the reference is added to the global list.

Parameters

global

~VariableReference()

sf::VariableReference::~VariableReference

(

)

Destructor.

Member Function Documentation

copy()

void sf::VariableReference::copy

(

const VariableReference &

ref

)

Copies the members to this instance except for the list and global members.

Member Data Documentation

_convertCurValue

Value sf::VariableReference::_convertCurValue

Converted current value.

_convertDefValue

Value sf::VariableReference::_convertDefValue

Converted default value.

_convertMaxValue

Value sf::VariableReference::_convertMaxValue

Converted maximum value.

_convertMinValue

Value sf::VariableReference::_convertMinValue

Converted minimum value.

_convertMultiplier

Value sf::VariableReference::_convertMultiplier

Multiplication value for convert calculation.

_convertOffset

Value sf::VariableReference::_convertOffset

offset value for convert calculation.

_convertOption

std::string sf::VariableReference::_convertOption

Conversion option.

_convertRndValue

Value sf::VariableReference::_convertRndValue

Converted rounding value.

_convertSigDigits

int sf::VariableReference::_convertSigDigits {0}

Significant digits after conversion.

_convertUnit

std::string sf::VariableReference::_convertUnit

Converted unit. String length of unit is used as a flag for conversion enabling.

_curFlags

flags_type sf::VariableReference::_curFlags {0}

Holds the current flags.

_curValue

Value sf::VariableReference::_curValue

current value.

_defValue

Value sf::VariableReference::_defValue

Default value.

_description

std::string sf::VariableReference::_description

Describes the variable.

_exported

bool sf::VariableReference::_exported {false}

Holds the exported flag for local variables.

_flags

flags_type sf::VariableReference::_flags {0}

Holds the flags at creation.

_global

bool sf::VariableReference::_global {false}

Holds the flag about the global status of this reference.

_id

id_type sf::VariableReference::_id {0}

In case of a global instance this value is a unique ID.

_list

PtrVector sf::VariableReference::_list

list of variables attached to this reference.

_localActive

int sf::VariableReference::_localActive {0}

Static this counter is increased if a local event is generated.
It is decreased when it returns from the event handler.

_maxValue

Value sf::VariableReference::_maxValue

Maximum value.

_minValue

Value sf::VariableReference::_minValue

Minimum value.

_name

std::string sf::VariableReference::_name

Name path separated by '|' characters.

_rndValue

Value sf::VariableReference::_rndValue

Rounding value.

_sigDigits

int sf::VariableReference::_sigDigits {0}

Significant digits based on the round value.

_states

State::Vector sf::VariableReference::_states

Vector which holds all states of this instance.

_type

Value::EType sf::VariableReference::_type {Value::vitUndefined}

Holds the internal type of the variable.

_unit

std::string sf::VariableReference::_unit

contains the SI unit or the string filter.

_valid

bool sf::VariableReference::_valid {false}

Holds the valid status of this reference.

---

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

• VariableReference.h