ReadVariableData Class Reference

The data for the readVariable method. More...

#include <client.h>

Inheritance diagram for ReadVariableData:

Public Member Functions
	ReadVariableData ()
	Class constructor.
	ReadVariableData (const ReadVariableData &src)
	Class copy constructor.
	ReadVariableData (const Variable &var)
	Class constructor from variable.
virtual	~ReadVariableData ()
	Destructor.
void	copyFrom (ReadVariableData &src)
	Performs a deep copy (i.e. clone) of the data from src
void	copyValuesFrom (const Variable::Data::Vector &src)
	Performs a deep copy of values (i.e. clone) from src
void	clear ()
	Clears the storage.
Variable &	var ()
	Get the definition [IN].
void	setVar (const Variable &value)
	Set the definition [IN].
bool	coherentValues () const
	Get the coherentValues flag [IN].
void	setCoherentValues (bool value)
	Set the coherentValues flag [IN].
SafeModes	safe () const
	Get the desired SafeModes [IN].
void	setSafe (SafeModes value)
	Set the desired SafeModes [IN].
Variable::Data::Vector &	values ()
	Get the list of obtained variable values. [OUT].
Public Member Functions inherited from OperationData
void	setState (uint64_t senderId, ActivityStates state, uint64_t data=0)
	Set the activity state.
void	setProgress (uint64_t senderId, int32_t min, int32_t max, int32_t cur)
	Set the activity progress.
Public Member Functions inherited from ErrorData
	ErrorData ()
	Class contructor.
void	setErrorFromMessage (Message *src)
	Set error information from a source message.
void	clearError ()
	Clear the error information.
void	setError (Message::ErrCodes errCode)
	Set the error information.
void	setError (Message::ErrCodes errCode, uint16_t errExtra)
	Set the error information.
Message::ErrCodes	nackErrCode () const
	Get the received NACK error code : if the value equals Message::errCodesNoError then no NACK message was received.
uint16_t	nackErrExtra () const
	Get the optional error extra data of the last NACK message received from the remote device.

Additional Inherited Members
Public Attributes inherited from OperationData
Signal3< uint64_t, ActivityStates, uint64_t >	stateChanged
	Signal emitted when the state of the operation changes.
Signal4< uint64_t, int32_t, int32_t, int32_t >	progressChanged
	Signal emitted when the progress of the operation changes.
Protected Member Functions inherited from ErrorData
void	setNackErrCode (Message::ErrCodes value)
	Set the received NACK error code : if the value equals Message::errCodesNoError then no NACK message was received.
void	setNackErrExtra (uint16_t value)
	Set the optional error extra data of the last NACK message received from the remote device.
uint16_t	nackErrFlags () const
	Get the error information validity flags.
void	setNackErrFlags (uint16_t value)
	Set the error information validity flags.

Detailed Description

The data for the readVariable method.

See also

Client.readVariable

Constructor & Destructor Documentation

ReadVariableData() [1/3]

ReadVariableData

(

)

Class constructor.

ReadVariableData() [2/3]

ReadVariableData

(

const ReadVariableData &

src

)

Class copy constructor.

Parameters

src	The source object

ReadVariableData() [3/3]

ReadVariableData

(

const Variable &

var

)

Class constructor from variable.

Parameters

var	The variable to use

~ReadVariableData()

virtual ~ReadVariableData ( )

virtual

Destructor.

Member Function Documentation

clear()

void clear

(

)

Clears the storage.

coherentValues()

bool coherentValues

(

)

const

Get the coherentValues flag [IN].

If setted, the message data size are limited to the protocol's maximum data size: data are retrieved with a single transition so they are garanteed to be coherent
If resetted, the message data size may exceed the protocol's maximum data size and are retrieved with multiple transitions , so they may be not coherent

Returns

The parameter value

copyFrom()

void copyFrom

(

ReadVariableData &

src

)

Performs a deep copy (i.e. clone) of the data from src

Parameters

src	The source object

copyValuesFrom()

void copyValuesFrom

(

const Variable::Data::Vector &

src

)

Performs a deep copy of values (i.e. clone) from src

Parameters

src	The source object

safe()

SafeModes safe

(

)

const

Get the desired SafeModes [IN].

Returns

The parameter value

setCoherentValues()

void setCoherentValues

(

bool

value

)

Set the coherentValues flag [IN].

If setted, the message data size are limited to the protocol's maximum data size: data are retrieved with a single transition so they are garanteed to be coherent
If resetted, the message data size may exceed the protocol's maximum data size and are retrieved with multiple transitions , so they may be not coherent

Parameters

value

The value to set

setSafe()

void setSafe

(

SafeModes

value

)

Set the desired SafeModes [IN].

Parameters

value

The value to set

setVar()

void setVar

(

const Variable &

value

)

Set the definition [IN].

Parameters

value

The value to set

values()

Variable::Data::Vector & values

(

)

Get the list of obtained variable values. [OUT].

Returns

The parameter value

var()

Variable & var

(

)

Get the definition [IN].

Returns

The parameter value