Robox Library for Cpp: BCC/31 module 1.0.0
RLibCpp BCC/31 protocol implementation
Public Member Functions | List of all members
WriteVariableData Class Reference

The data for the writeVariable method. More...

#include <client.h>

Inheritance diagram for WriteVariableData:
BaseWriteVariableData OperationData ErrorData

Public Member Functions

 WriteVariableData ()
 Class constructor.
 
 WriteVariableData (const WriteVariableData &src)
 Class copy constructor.
 
 WriteVariableData (const Variable &var)
 Class constructor from variable.
 
- Public Member Functions inherited from BaseWriteVariableData
 BaseWriteVariableData ()
 Class constructor.
 
 BaseWriteVariableData (const BaseWriteVariableData &src)
 Class copy constructor.
 
 BaseWriteVariableData (const Variable &var)
 Class constructor from variable.
 
void copyFrom (BaseWriteVariableData &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.
 
Variablevar ()
 Get the definition [IN].
 
void setVar (const Variable &value)
 Set the definition [IN].
 
SafeModes safe () const
 Get the desired SafeModes [IN].
 
void setSafe (SafeModes value)
 Set the desired SafeModes [IN].
 
bool coherentValues () const
 Get the coherentValues flag [IN].
 
void setCoherentValues (bool value)
 Set the coherentValues flag [IN].
 
Variable::Data::Vectorvalues ()
 Get the list of variable values. [IN].
 
void setValues (const Variable::Data::Vector &value)
 Set the list of variable values. [IN].
 
- 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 writeVariable method.

See also
Client.writeVariable

Constructor & Destructor Documentation

◆ WriteVariableData() [1/3]

Class constructor.

◆ WriteVariableData() [2/3]

Class copy constructor.

Parameters
srcThe source object

◆ WriteVariableData() [3/3]

WriteVariableData ( const Variable & var)

Class constructor from variable.

Parameters
varThe variable to use