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

The data for the sysReportList method. More...

#include <client.h>

Inheritance diagram for SysReportListData:
OperationData ErrorData

Public Member Functions

uint32_t fromID () const
 Get the ID of the first report item [IN].
 
void setFromID (uint32_t value)
 Set the ID of the first report item [IN].
 
uint32_t toID () const
 Get the ID of the last report item [IN].
 
void setToID (uint32_t value)
 Set the ID of the last report item [IN].
 
uint16_t numItems () const
 Get the No. of report items [IN].
 
void setNumItems (uint16_t value)
 Set the No. of report items [IN].
 
SysReportListItem::Vectoritems ()
 Get the result list of read items. [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 sysReportList method.

Member Function Documentation

◆ fromID()

uint32_t fromID ( ) const

Get the ID of the first report item [IN].

Returns
The parameter value

◆ items()

Get the result list of read items. [OUT].

Returns
The parameter value

◆ numItems()

ushort numItems ( ) const

Get the No. of report items [IN].

Returns
The parameter value

◆ setFromID()

void setFromID ( uint32_t value)

Set the ID of the first report item [IN].

Parameters
valueThe value to set

◆ setNumItems()

void setNumItems ( uint16_t value)

Set the No. of report items [IN].

Parameters
valueThe value to set

◆ setToID()

void setToID ( uint32_t value)

Set the ID of the last report item [IN].

Parameters
valueThe value to set

◆ toID()

uint32_t toID ( ) const

Get the ID of the last report item [IN].

Returns
The parameter value