Robox Library for Cpp: BCC/31 module 1.0.0
RLibCpp BCC/31 protocol implementation
|
The data for the canObjRead method. More...
#include <client.h>
Public Types | |
enum | Types { typeSigned = -1 , typeUnsigned = 1 , typeFloat = 5 } |
Data types. More... | |
enum | Flagss { flagErrorOnSDO = 0x00000001 } |
Reply flags. More... | |
Public Member Functions | |
uint16_t | wsID () const |
Get the workstation ID [IN]. | |
void | setWsID (uint16_t value) |
Set the workstation ID [IN]. | |
uint16_t | objectIndex () const |
Get the object index [IN]. | |
void | setObjectIndex (uint16_t value) |
Set the object index [IN]. | |
uint16_t | objectSubIndex () const |
Get the object sub-index [IN]. | |
void | setObjectSubIndex (uint16_t value) |
Set the object sub-index [IN]. | |
Types | type () const |
Get the object data type [IN]. | |
void | setType (Types value) |
Set the object data type [IN]. | |
Flagss | flags () const |
Get the readout reply flags [OUT]. | |
void | setFlags (Flagss value) |
Set the readout reply flags [OUT]. | |
double | data () const |
Get the readout data [OUT]. | |
void | setData (double value) |
Set the readout data [OUT]. | |
uint32_t | errorCode () const |
Get the readout error code (if flagss contains Flagss::flagErrorOnSDO) [OUT]. | |
void | setErrorCode (uint32_t value) |
Set the readout error code (if flagss contains Flagss::flagErrorOnSDO) [OUT]. | |
String & | errorText () |
Get the readout error text (if flagss contains Flagss::flagErrorOnSDO) [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. | |
The data for the canObjRead method.
enum Flagss |
enum Types |
double data | ( | ) | const |
Get the readout data [OUT].
uint32_t errorCode | ( | ) | const |
Get the readout error code (if flagss contains Flagss::flagErrorOnSDO) [OUT].
String & errorText | ( | ) |
Get the readout error text (if flagss contains Flagss::flagErrorOnSDO) [OUT].
Flagss flags | ( | ) | const |
Get the readout reply flags [OUT].
ushort objectIndex | ( | ) | const |
Get the object index [IN].
ushort objectSubIndex | ( | ) | const |
Get the object sub-index [IN].
void setData | ( | double | value | ) |
Set the readout data [OUT].
value | The value to set |
void setErrorCode | ( | uint32_t | value | ) |
Set the readout error code (if flagss contains Flagss::flagErrorOnSDO) [OUT].
value | The value to set |
void setFlags | ( | Flagss | value | ) |
Set the readout reply flags [OUT].
value | The value to set |
void setObjectIndex | ( | uint16_t | value | ) |
Set the object index [IN].
value | The value to set |
void setObjectSubIndex | ( | uint16_t | value | ) |
Set the object sub-index [IN].
value | The value to set |
void setType | ( | Types | value | ) |
Set the object data type [IN].
value | The value to set |
void setWsID | ( | uint16_t | value | ) |
Set the workstation ID [IN].
value | The value to set |
Types type | ( | ) | const |
Get the object data type [IN].
ushort wsID | ( | ) | const |
Get the workstation ID [IN].