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

The data for the releaseVariable method. More...

#include <client.h>

Inheritance diagram for ReleaseVariableData:
OperationData ErrorData

Public Member Functions

 ReleaseVariableData ()
 Class constructor.
 
 ReleaseVariableData (const Variable &var)
 Class constructor from variable.
 
Variablevar ()
 Get the definition.
 
void setVar (const Variable &value)
 Set the definition.
 
SafeModes safe () const
 Get the desired SafeModes
 
void setSafe (SafeModes value)
 Set the desired SafeModes
 
- 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 releaseVariable method.

See also
Client.releaseVariable

Constructor & Destructor Documentation

◆ ReleaseVariableData() [1/2]

Class constructor.

◆ ReleaseVariableData() [2/2]

ReleaseVariableData ( const Variable & var)

Class constructor from variable.

Parameters
varThe variable to use

Member Function Documentation

◆ safe()

SafeModes safe ( ) const

Get the desired SafeModes

Returns
The parameter value

◆ setSafe()

void setSafe ( SafeModes value)

Set the desired SafeModes

Parameters
valueThe value to set

◆ setVar()

void setVar ( const Variable & value)

Set the definition.

Parameters
valueThe value to set

◆ var()

Variable & var ( )

Get the definition.

Returns
The parameter value