Connection::VariablesDict Class Reference

The variable dictionay. More...

#include <connection.h>

Public Member Functions
	VariablesDict (Connection *connection)
	The constructor.
virtual	~VariablesDict ()
	The destructor.
String	vtxPath ()
	Get the VtxManager path.
void	setVtxPath (const String &value)
	Set the VtxManager path.
Globals::Results	update (Client &client)
	Helper method to update the variable dictionary.
void	clear ()
	Clears the variable dictionary.
Globals::Results	parseVar (const String &name, RVar::Dict::VarData::PtrVector &varDataList, RVar::Dict::ParseFlags parseFlags=RVar::Dict::pfDefault)
	Wrapper for variable parsing.
Globals::Results	parseVar (const String &name, uint32_t startMsgOffset, uint32_t msgOffset, RVar::Dict::VarData::PtrVector &varDataList, RVar::Index &srcIndex, RVar::Dict::ParseFlags parseFlags=RVar::Dict::pfDefault)
	Wrapper for variable parsing.
bool	valid () const
	Get the flag to indicate if Connection::varDict() is valid.
void	setValid (bool value)
	Set the flag to indicate if Connection::varDict() is valid.
bool	updating () const
	Get the state of the update in progress.

Protected Member Functions
void	setUpdating (bool value)
	Set the state of the update in progress.

Detailed Description

The variable dictionay.

Constructor & Destructor Documentation

VariablesDict()

VariablesDict

(

Connection *

connection

)

The constructor.

Parameters

connection

The connection to use

~VariablesDict()

virtual ~VariablesDict ( )

virtual

The destructor.

Member Function Documentation

clear()

void clear

(

)

Clears the variable dictionary.

parseVar() [1/2]

Globals::Results parseVar	(	const String &	name,
		RVar::Dict::VarData::PtrVector &	varDataList,
		RVar::Dict::ParseFlags	parseFlags = RVar::Dict::pfDefault )

Wrapper for variable parsing.

Parameters

name	Name of the variable
varDataList	The returned list of RVar::Dict::VarData
parseFlags	Parsing flags (RVar::Dict::ParseFlags). Optional : default value is RVar::Dict::pfDefault

Returns

Return the operation result code.

parseVar() [2/2]

Globals::Results parseVar	(	const String &	name,
		uint32_t	startMsgOffset,
		uint32_t	msgOffset,
		RVar::Dict::VarData::PtrVector &	varDataList,
		RVar::Index &	srcIndex,
		RVar::Dict::ParseFlags	parseFlags = RVar::Dict::pfDefault )

Wrapper for variable parsing.

Parameters

name	Name of the variable
startMsgOffset	Message offset to be used on new var
msgOffset	Message offset for the first var
varDataList	The returned list of RVar::VarData
srcIndex	The returned source indes RVar::Index
parseFlags	Parsing flags (RVar::Dict::ParseFlags). Optional : default value is RVar::Dict::pfDefault

Returns

Return the operation result code.

setUpdating()

void setUpdating ( bool value )

protected

Set the state of the update in progress.

Parameters

value

The value to set

setValid()

void setValid

(

bool

value

)

Set the flag to indicate if Connection::varDict() is valid.

Parameters

value

The value to set

setVtxPath()

void setVtxPath

(

const String &

value

)

Set the VtxManager path.

Parameters

value

The value to set

update()

Globals::Results update

(

Client &

client

)

Helper method to update the variable dictionary.

Returns

Returns operation logical result.

updating()

bool updating

(

)

const

Get the state of the update in progress.

Returns

The parameter value

valid()

bool valid

(

)

const

Get the flag to indicate if Connection::varDict() is valid.

Returns

The parameter value

vtxPath()

String vtxPath

(

)

Get the VtxManager path.

Returns

The VtxManager path