The variable specification data. More...

#include <variable.h>

Classes
class	Data
	Class to handle variable data values. More...

Public Member Functions
	Variable ()
	Default constructor.

virtual	~Variable ()
	Class destructor.

Message::VarTypes	type () const
	Get the variable type.

void	setType (Message::VarTypes value)
	Set the variable type.

uint32_t	index () const
	Get the variable type.

void	setIndex (uint32_t value)
	Set the variable type.

uint32_t	count () const
	Get the number of consecutive variables.

void	setCount (uint32_t value)
	Set the number of consecutive variables.

uint32_t	bit () const
	Get the variable bit index.

void	setBit (uint32_t value)
	Set the variable bit index.

uint32_t	size () const
	Get the variable size.

void	setSize (uint32_t value)
	Set the variable size.

uint32_t	axIndex () const
	Get the first axis index.

void	setAxIndex (uint32_t value)
	Set the first axis index.

uint32_t	axCount () const
	Get the number of consecutive axes.

void	setAxCount (uint32_t value)
	Set the number of consecutive axes.

String &	name ()
	Get the name of the variable.

void	setName (const String &value)
	Set the name of the variable.

uint32_t	cacheId () const
	Get the id of the variable into cache.

void	setCacheId (uint32_t value)
	Set the id of the variable into cache.

Static Public Member Functions
static Variable	fromVR16 (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varVR16 variable.

static Variable	fromNvR16 (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varNvR16 variable.

static Variable	fromLogIW16 (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varLogIW16 variable.

static Variable	fromLogOW16 (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varLogOW16 variable.

static Variable	fromPhyIW16 (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varPhyIW16 variable.

static Variable	fromPhyOW16 (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varPhyOW16 variable.

static Variable	fromParamI16 (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varParamI16 variable.

static Variable	fromVR32 (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varVR32 variable.

static Variable	fromNvR32 (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varNvR32 variable.

static Variable	fromLogIW32 (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varLogIW32 variable.

static Variable	fromLogOW32 (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varLogOW32 variable.

static Variable	fromPhyIW32 (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varPhyIW32 variable.

static Variable	fromPhyOW32 (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varPhyOW32 variable.

static Variable	fromParamI32 (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varParamI32 variable.

static Variable	fromParamF (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varParamF variable.

static Variable	fromAM (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varAM variable.

static Variable	fromAlarmN (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varAlarmN variable.

static Variable	fromVR64 (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varVR64 variable.

static Variable	fromNvR64 (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varNvR64 variable.

static Variable	fromParamI64 (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varParamI64 variable.

static Variable	fromVRR (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varVRR variable.

static Variable	fromNvRR (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varNvRR variable.

static Variable	fromParamR (uint32_t index, uint32_t count=1)
	Factory method to create and initialize a Message::varParamR variable.

static Variable	fromVSR (uint32_t index, uint32_t size=128)
	Factory method to create and initialize a Message::varVSR variable.

static Variable	fromNvSR (uint32_t index, uint32_t size=128)
	Factory method to create and initialize a Message::varNvSR variable.

static Variable	fromAlarmS (uint32_t index, uint32_t size=64)
	Factory method to create and initialize a Message::varAlarmS variable.

static Variable	fromLogIC (uint32_t index)
	Factory method to create and initialize a Message::varLogIC variable.

static Variable	fromLogOC (uint32_t index)
	Factory method to create and initialize a Message::varLogOC variable.

static Variable	fromPhyIC (uint32_t index)
	Factory method to create and initialize a Message::varPhyIC variable.

static Variable	fromPhyOC (uint32_t index)
	Factory method to create and initialize a Message::varPhyOC variable.

static Variable	fromAxisI16 (uint32_t index, uint32_t axIndex, uint32_t axCount=1)
	Factory method to create and initialize a Message::varAxisI16 variable.

static Variable	fromAxisI32 (uint32_t index, uint32_t axIndex, uint32_t axCount=1)
	Factory method to create and initialize a Message::varAxisI32 variable.

static Variable	fromAxisF (uint32_t index, uint32_t axIndex, uint32_t axCount=1)
	Factory method to create and initialize a Message::varAxisF variable.

static Variable	fromAxisI64 (uint32_t index, uint32_t axIndex, uint32_t axCount=1)
	Factory method to create and initialize a Message::varAxisI64 variable.

static Variable	fromAxisR (uint32_t index, uint32_t axIndex, uint32_t axCount=1)
	Factory method to create and initialize a Message::varAxisR variable.

static Variable	fromBitVR16 (uint32_t index, uint32_t bit)
	Factory method to create and initialize a Message::varBitVR16 variable.

static Variable	fromBitNvR16 (uint32_t index, uint32_t bit)
	Factory method to create and initialize a Message::varBitNvR16 variable.

static Variable	fromBitLogIW16 (uint32_t index, uint32_t bit)
	Factory method to create and initialize a Message::varBitLogIW16 variable.

static Variable	fromBitLogOW16 (uint32_t index, uint32_t bit)
	Factory method to create and initialize a Message::varBitLogOW16 variable.

static Variable	fromBitPhyIW16 (uint32_t index, uint32_t bit)
	Factory method to create and initialize a Message::varBitPhyIW16 variable.

static Variable	fromBitPhyOW16 (uint32_t index, uint32_t bit)
	Factory method to create and initialize a Message::varBitPhyOW16 variable.

static Variable	fromBitVR32 (uint32_t index, uint32_t bit)
	Factory method to create and initialize a Message::varBitVR32 variable.

static Variable	fromBitNvR32 (uint32_t index, uint32_t bit)
	Factory method to create and initialize a Message::varBitNvR32 variable.

static Variable	fromBitLogIW32 (uint32_t index, uint32_t bit)
	Factory method to create and initialize a Message::varBitLogIW32 variable.

static Variable	fromBitLogOW32 (uint32_t index, uint32_t bit)
	Factory method to create and initialize a Message::varBitLogOW32 variable.

static Variable	fromBitPhyIW32 (uint32_t index, uint32_t bit)
	Factory method to create and initialize a Message::varBitPhyIW32 variable.

static Variable	fromBitPhyOW32 (uint32_t index, uint32_t bit)
	Factory method to create and initialize a Message::varBitPhyOW32 variable.

static Variable	fromBitAM (uint32_t index, uint32_t bit)
	Factory method to create and initialize a Message::varBitAM variable.

static Variable	fromBitVR64 (uint32_t index, uint32_t bit)
	Factory method to create and initialize a Message::varBitVR64 variable.

static Variable	fromBitNvR64 (uint32_t index, uint32_t bit)
	Factory method to create and initialize a Message::varBitNvR64 variable.

static Variable	fromName (const String &name)
	Factory method to create and initialize a Message::varNamed variable.

static Variable	fromCache (uint32_t cacheId)
	Factory method to create and initialize a Message::varNamed variable.

Static Protected Member Functions
static Variable &	doInitStdVariable (Variable &var, Message::VarTypes type, uint32_t index, uint32_t count)
	Helper method to create and inizialize a standard variable.

static Variable &	doInitStringVariable (Variable &var, Message::VarTypes type, uint32_t index, uint32_t size)
	Helper method to create and inizialize a string variable.

static Variable &	doInitCharVariable (Variable &var, Message::VarTypes type, uint32_t index)
	Helper method to create and inizialize a char variable.

static Variable &	doInitAxisVariable (Variable &var, Message::VarTypes type, uint32_t index, uint32_t axIndex, uint32_t axCount)
	Helper method to create and inizialize an axis variable.

static Variable &	doInitBitVariable (Variable &var, Message::VarTypes type, uint32_t index, uint32_t bit)
	Helper method to create and inizialize a bit variable.

static Variable &	doInitNamedVariable (Variable &var, Message::VarTypes type, const String &name)
	Helper method to create and inizialize a named variable.

static Variable &	doInitCachedVariable (Variable &var, Message::VarTypes type, uint32_t cacheId)
	Helper method to create and inizialize a cached variable.

Detailed Description

The variable specification data.

This class allows to specify a variable from type or name or cache

Some static factory methods help you to create the variable with proper values setted

Constructor & Destructor Documentation

◆ Variable()

Variable ( )

Default constructor.

Creates an invalid variable (Message::varInvalid) and all the fields must be initialized

◆ ~Variable()

virtual ~Variable ( )

virtual

Class destructor.

Member Function Documentation

◆ axCount()

uint32_t axCount ( ) const

Get the number of consecutive axes.

Returns: The parameter value

Remarks: Required only by the following types: Message::varAxisI16, Message::varAxisI32, Message::varAxisF, Message::varAxisI64, Message::varAxisR.

◆ axIndex()

uint32_t axIndex ( ) const

Get the first axis index.

Returns: The parameter value

Remarks: Required only by the following types: Message::varAxisI16, Message::varAxisI32, Message::varAxisF, Message::varAxisI64, Message::varAxisR.

◆ bit()

uint32_t bit ( ) const

Get the variable bit index.

Returns: The parameter value

Remarks: Required only by the following types: Message::varBitVR16, Message::varBitNvR16, Message::varBitLogIW16, Message::varBitLogOW16, Message::varBitPhyIW16, Message::varBitPhyOW16, Message::varBitVR32, Message::varBitNvR32, Message::varBitLogIW32, Message::varBitLogOW32, Message::varBitPhyIW32, Message::varBitPhyOW32, Message::varBitAM, Message::varBitVR64, Message::varBitNvR64.

◆ cacheId()

uint32_t cacheId ( ) const

Get the id of the variable into cache.

Returns: The parameter value

Remarks: Required only by the following types: Message::varCached.

◆ count()

uint32_t count ( ) const

Get the number of consecutive variables.

Returns: The parameter value

◆ doInitAxisVariable()

static Variable & doInitAxisVariable	(	Variable &	var,
		Message::VarTypes	type,
		uint32_t	index,
		uint32_t	axIndex,
		uint32_t	axCount )

staticprotected

Helper method to create and inizialize an axis variable.

Parameters

var	The variable storage to be initialize
type	The type of variable
index	The variable index
axIndex	The axis index
axCount	The number of axis

Returns: A reference to the initialized var

◆ doInitBitVariable()

static Variable & doInitBitVariable	(	Variable &	var,
		Message::VarTypes	type,
		uint32_t	index,
		uint32_t	bit )

staticprotected

Helper method to create and inizialize a bit variable.

Parameters

var	The variable storage to be initialize
type	The type of variable
index	The variable index
bit	The bit number

Returns: A reference to the initialized var

◆ doInitCachedVariable()

static Variable & doInitCachedVariable	(	Variable &	var,
		Message::VarTypes	type,
		uint32_t	cacheId )

staticprotected

Helper method to create and inizialize a cached variable.

Parameters

var	The variable storage to be initialize
type	The type of variable
cacheId	The variable identifier into cache

Returns: A reference to the initialized var

◆ doInitCharVariable()

static Variable & doInitCharVariable	(	Variable &	var,
		Message::VarTypes	type,
		uint32_t	index )

staticprotected

Helper method to create and inizialize a char variable.

Parameters

var	The variable storage to be initialize
type	The type of variable
index	The variable index

Returns: A reference to the initialized var

◆ doInitNamedVariable()

static Variable & doInitNamedVariable	(	Variable &	var,
		Message::VarTypes	type,
		const String &	name )

staticprotected

Helper method to create and inizialize a named variable.

Parameters

var	The variable storage to be initialize
type	The type of variable
name	The variable definition

Returns: A reference to the initialized var

◆ doInitStdVariable()

static Variable & doInitStdVariable	(	Variable &	var,
		Message::VarTypes	type,
		uint32_t	index,
		uint32_t	count )

staticprotected

Helper method to create and inizialize a standard variable.

Parameters

var	The variable storage to be initialize
type	The type of variable
index	The variable index
count	The number of repetitions

Returns: A reference to the initialized var

◆ doInitStringVariable()

static Variable & doInitStringVariable	(	Variable &	var,
		Message::VarTypes	type,
		uint32_t	index,
		uint32_t	size )

staticprotected

Helper method to create and inizialize a string variable.

Parameters

var	The variable storage to be initialize
type	The type of variable
index	The variable index
size	The size of the string

Returns: A reference to the initialized var

◆ fromAlarmN()

static Variable fromAlarmN	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varAlarmN variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromAlarmS()

static Variable fromAlarmS	(	uint32_t	index,
		uint32_t	size = 64 )

static

Factory method to create and initialize a Message::varAlarmS variable.

Parameters

index	The variable index
size	The size of the string

Returns: The initialized Variable

◆ fromAM()

static Variable fromAM	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varAM variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromAxisF()

static Variable fromAxisF	(	uint32_t	index,
		uint32_t	axIndex,
		uint32_t	axCount = 1 )

static

Factory method to create and initialize a Message::varAxisF variable.

Parameters

index	The variable index
axIndex	The axis index
axCount	The number of axis

Returns: The initialized Variable

◆ fromAxisI16()

static Variable fromAxisI16	(	uint32_t	index,
		uint32_t	axIndex,
		uint32_t	axCount = 1 )

static

Factory method to create and initialize a Message::varAxisI16 variable.

Parameters

index	The variable index
axIndex	The axis index
axCount	The number of axis

Returns: The initialized Variable

◆ fromAxisI32()

static Variable fromAxisI32	(	uint32_t	index,
		uint32_t	axIndex,
		uint32_t	axCount = 1 )

static

Factory method to create and initialize a Message::varAxisI32 variable.

Parameters

index	The variable index
axIndex	The axis index
axCount	The number of axis

Returns: The initialized Variable

◆ fromAxisI64()

static Variable fromAxisI64	(	uint32_t	index,
		uint32_t	axIndex,
		uint32_t	axCount = 1 )

static

Factory method to create and initialize a Message::varAxisI64 variable.

Parameters

index	The variable index
axIndex	The axis index
axCount	The number of axis

Returns: The initialized Variable

◆ fromAxisR()

static Variable fromAxisR	(	uint32_t	index,
		uint32_t	axIndex,
		uint32_t	axCount = 1 )

static

Factory method to create and initialize a Message::varAxisR variable.

Parameters

index	The variable index
axIndex	The axis index
axCount	The number of axis

Returns: The initialized Variable

◆ fromBitAM()

static Variable fromBitAM	(	uint32_t	index,
		uint32_t	bit )

static

Factory method to create and initialize a Message::varBitAM variable.

Parameters

index	The variable index
bit	The bit number

Returns: The initialized Variable

◆ fromBitLogIW16()

static Variable fromBitLogIW16	(	uint32_t	index,
		uint32_t	bit )

static

Factory method to create and initialize a Message::varBitLogIW16 variable.

Parameters

index	The variable index
bit	The bit number

Returns: The initialized Variable

◆ fromBitLogIW32()

static Variable fromBitLogIW32	(	uint32_t	index,
		uint32_t	bit )

static

Factory method to create and initialize a Message::varBitLogIW32 variable.

Parameters

index	The variable index
bit	The bit number

Returns: The initialized Variable

◆ fromBitLogOW16()

static Variable fromBitLogOW16	(	uint32_t	index,
		uint32_t	bit )

static

Factory method to create and initialize a Message::varBitLogOW16 variable.

Parameters

index	The variable index
bit	The bit number

Returns: The initialized Variable

◆ fromBitLogOW32()

static Variable fromBitLogOW32	(	uint32_t	index,
		uint32_t	bit )

static

Factory method to create and initialize a Message::varBitLogOW32 variable.

Parameters

index	The variable index
bit	The bit number

Returns: The initialized Variable

◆ fromBitNvR16()

static Variable fromBitNvR16	(	uint32_t	index,
		uint32_t	bit )

static

Factory method to create and initialize a Message::varBitNvR16 variable.

Parameters

index	The variable index
bit	The bit number

Returns: The initialized Variable

◆ fromBitNvR32()

static Variable fromBitNvR32	(	uint32_t	index,
		uint32_t	bit )

static

Factory method to create and initialize a Message::varBitNvR32 variable.

Parameters

index	The variable index
bit	The bit number

Returns: The initialized Variable

◆ fromBitNvR64()

static Variable fromBitNvR64	(	uint32_t	index,
		uint32_t	bit )

static

Factory method to create and initialize a Message::varBitNvR64 variable.

Parameters

index	The variable index
bit	The bit number

Returns: The initialized Variable

◆ fromBitPhyIW16()

static Variable fromBitPhyIW16	(	uint32_t	index,
		uint32_t	bit )

static

Factory method to create and initialize a Message::varBitPhyIW16 variable.

Parameters

index	The variable index
bit	The bit number

Returns: The initialized Variable

◆ fromBitPhyIW32()

static Variable fromBitPhyIW32	(	uint32_t	index,
		uint32_t	bit )

static

Factory method to create and initialize a Message::varBitPhyIW32 variable.

Parameters

index	The variable index
bit	The bit number

Returns: The initialized Variable

◆ fromBitPhyOW16()

static Variable fromBitPhyOW16	(	uint32_t	index,
		uint32_t	bit )

static

Factory method to create and initialize a Message::varBitPhyOW16 variable.

Parameters

index	The variable index
bit	The bit number

Returns: The initialized Variable

◆ fromBitPhyOW32()

static Variable fromBitPhyOW32	(	uint32_t	index,
		uint32_t	bit )

static

Factory method to create and initialize a Message::varBitPhyOW32 variable.

Parameters

index	The variable index
bit	The bit number

Returns: The initialized Variable

◆ fromBitVR16()

static Variable fromBitVR16	(	uint32_t	index,
		uint32_t	bit )

static

Factory method to create and initialize a Message::varBitVR16 variable.

Parameters

index	The variable index
bit	The bit number

Returns: The initialized Variable

◆ fromBitVR32()

static Variable fromBitVR32	(	uint32_t	index,
		uint32_t	bit )

static

Factory method to create and initialize a Message::varBitVR32 variable.

Parameters

index	The variable index
bit	The bit number

Returns: The initialized Variable

◆ fromBitVR64()

static Variable fromBitVR64	(	uint32_t	index,
		uint32_t	bit )

static

Factory method to create and initialize a Message::varBitVR64 variable.

Parameters

index	The variable index
bit	The bit number

Returns: The initialized Variable

◆ fromCache()

static Variable fromCache ( uint32_t cacheId )

static

Factory method to create and initialize a Message::varNamed variable.

Parameters

cacheId The variable identifier into cache

Returns: The initialized Variable

◆ fromLogIC()

static Variable fromLogIC ( uint32_t index )

static

Factory method to create and initialize a Message::varLogIC variable.

Parameters

index The variable index

Returns: The initialized Variable

◆ fromLogIW16()

static Variable fromLogIW16	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varLogIW16 variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromLogIW32()

static Variable fromLogIW32	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varLogIW32 variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromLogOC()

static Variable fromLogOC ( uint32_t index )

static

Factory method to create and initialize a Message::varLogOC variable.

Parameters

index The variable index

Returns: The initialized Variable

◆ fromLogOW16()

static Variable fromLogOW16	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varLogOW16 variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromLogOW32()

static Variable fromLogOW32	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varLogOW32 variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromName()

static Variable fromName ( const String & name )

static

Factory method to create and initialize a Message::varNamed variable.

Parameters

name	The name of the variable : variable name syntax is RDE35 like

Returns: The initialized Variable

◆ fromNvR16()

static Variable fromNvR16	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varNvR16 variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromNvR32()

static Variable fromNvR32	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varNvR32 variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromNvR64()

static Variable fromNvR64	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varNvR64 variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromNvRR()

static Variable fromNvRR	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varNvRR variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromNvSR()

static Variable fromNvSR	(	uint32_t	index,
		uint32_t	size = 128 )

static

Factory method to create and initialize a Message::varNvSR variable.

Parameters

index	The variable index
size	The size of the string

Returns: The initialized Variable

◆ fromParamF()

static Variable fromParamF	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varParamF variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromParamI16()

static Variable fromParamI16	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varParamI16 variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromParamI32()

static Variable fromParamI32	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varParamI32 variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromParamI64()

static Variable fromParamI64	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varParamI64 variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromParamR()

static Variable fromParamR	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varParamR variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromPhyIC()

static Variable fromPhyIC ( uint32_t index )

static

Factory method to create and initialize a Message::varPhyIC variable.

Parameters

index The variable index

Returns: The initialized Variable

◆ fromPhyIW16()

static Variable fromPhyIW16	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varPhyIW16 variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromPhyIW32()

static Variable fromPhyIW32	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varPhyIW32 variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromPhyOC()

static Variable fromPhyOC ( uint32_t index )

static

Factory method to create and initialize a Message::varPhyOC variable.

Parameters

index The variable index

Returns: The initialized Variable

◆ fromPhyOW16()

static Variable fromPhyOW16	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varPhyOW16 variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromPhyOW32()

static Variable fromPhyOW32	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varPhyOW32 variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromVR16()

static Variable fromVR16	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varVR16 variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromVR32()

static Variable fromVR32	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varVR32 variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromVR64()

static Variable fromVR64	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varVR64 variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromVRR()

static Variable fromVRR	(	uint32_t	index,
		uint32_t	count = 1 )

static

Factory method to create and initialize a Message::varVRR variable.

Parameters

index	The variable index
count	The number of repetitions

Returns: The initialized Variable

◆ fromVSR()

static Variable fromVSR	(	uint32_t	index,
		uint32_t	size = 128 )

static

Factory method to create and initialize a Message::varVSR variable.

Parameters

index	The variable index
size	The size of the string

Returns: The initialized Variable

◆ index()

uint32_t index ( ) const

Get the variable type.

Returns: The parameter value

Remarks: Required by all the types

◆ name()

QString & name ( )

Get the name of the variable.

Returns: The parameter value

Remarks: Required only by the following types: Message::varNamed.

◆ setAxCount()

void setAxCount ( uint32_t value )

Set the number of consecutive axes.

Parameters

value The value to set

Remarks: Required only by the following types: Message::varAxisI16, Message::varAxisI32, Message::varAxisF, Message::varAxisI64, Message::varAxisR.

◆ setAxIndex()

void setAxIndex ( uint32_t value )

Set the first axis index.

Parameters

value The value to set

Remarks: Required only by the following types: Message::varAxisI16, Message::varAxisI32, Message::varAxisF, Message::varAxisI64, Message::varAxisR.

◆ setBit()

void setBit ( uint32_t value )

Set the variable bit index.

Parameters

value The value to set

Remarks: Required only by the following types: Message::varBitVR16, Message::varBitNvR16, Message::varBitLogIW16, Message::varBitLogOW16, Message::varBitPhyIW16, Message::varBitPhyOW16, Message::varBitVR32, Message::varBitNvR32, Message::varBitLogIW32, Message::varBitLogOW32, Message::varBitPhyIW32, Message::varBitPhyOW32, Message::varBitAM, Message::varBitVR64, Message::varBitNvR64.

◆ setCacheId()

void setCacheId ( uint32_t value )

Set the id of the variable into cache.

Parameters

value The value to set

Remarks: Required only by the following types: Message::varCached.

◆ setCount()

void setCount ( uint32_t value )

Set the number of consecutive variables.

Parameters

value The value to set

◆ setIndex()

void setIndex ( uint32_t value )

Set the variable type.

Parameters

value The value to set

Remarks: Required by all the types

◆ setName()

void setName ( const String & value )

Set the name of the variable.

Parameters

value The value to set

Remarks: Required only by the following types: Message::varNamed.

◆ setSize()

void setSize ( uint32_t value )

Set the variable size.

Parameters

value The value to set

Remarks: Required only by the following types: Message::varVSR, Message::varNvSR

◆ setType()

void setType ( Message::VarTypes value )

Set the variable type.

Parameters

value The value to set

Remarks: Required by all the types

◆ size()

uint32_t size ( ) const

Get the variable size.

Returns: The parameter value

Remarks: Required only by the following types: Message::varVSR, Message::varNvSR

◆ type()

Message::VarTypes type ( ) const

Get the variable type.

Returns: The parameter value

Remarks: Required by all the types

Classes

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Variable()

◆ ~Variable()

Member Function Documentation

◆ axCount()

◆ axIndex()

◆ bit()

◆ cacheId()

◆ count()

◆ doInitAxisVariable()

◆ doInitBitVariable()

◆ doInitCachedVariable()

◆ doInitCharVariable()

◆ doInitNamedVariable()

◆ doInitStdVariable()

◆ doInitStringVariable()

◆ fromAlarmN()

◆ fromAlarmS()

◆ fromAM()

◆ fromAxisF()

◆ fromAxisI16()

◆ fromAxisI32()

◆ fromAxisI64()

◆ fromAxisR()

◆ fromBitAM()

◆ fromBitLogIW16()

◆ fromBitLogIW32()

◆ fromBitLogOW16()

◆ fromBitLogOW32()

◆ fromBitNvR16()

◆ fromBitNvR32()

◆ fromBitNvR64()

◆ fromBitPhyIW16()

◆ fromBitPhyIW32()

◆ fromBitPhyOW16()

◆ fromBitPhyOW32()

◆ fromBitVR16()

◆ fromBitVR32()

◆ fromBitVR64()

◆ fromCache()

◆ fromLogIC()

◆ fromLogIW16()

◆ fromLogIW32()

◆ fromLogOC()

◆ fromLogOW16()

◆ fromLogOW32()

◆ fromName()

◆ fromNvR16()

◆ fromNvR32()

◆ fromNvR64()

◆ fromNvRR()

◆ fromNvSR()

◆ fromParamF()

◆ fromParamI16()

◆ fromParamI32()

◆ fromParamI64()

◆ fromParamR()

◆ fromPhyIC()

◆ fromPhyIW16()

◆ fromPhyIW32()

◆ fromPhyOC()

◆ fromPhyOW16()

◆ fromPhyOW32()

◆ fromVR16()

◆ fromVR32()

◆ fromVR64()

◆ fromVRR()

◆ fromVSR()

◆ index()

◆ name()

◆ setAxCount()

◆ setAxIndex()

◆ setBit()

◆ setCacheId()

◆ setCount()