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

the data for the reportInfo method. More...

#include <client.h>

Inheritance diagram for ReportInfoData:
OperationData ErrorData

Public Member Functions

uint32_t oldId () const
 Get the oldest report item ID [OUT].
 
void setOldId (uint32_t value)
 Set the oldest report item ID [OUT].
 
uint32_t newId () const
 Get the newest report item ID [OUT].
 
void setNewId (uint32_t value)
 Set the newest report item ID [OUT].
 
uint32_t numItems () const
 Get the No.of report items (in range from oldId to newId, all included) [OUT].
 
void setNumItems (uint32_t value)
 Set the No.of report items (in range from oldId to newId, all included) [OUT].
 
uint32_t size () const
 Get the report size (no.of storable items) [OUT].
 
void setSize (uint32_t value)
 Set the report size (no.of storable items) [OUT].
 
uint32_t repID () const
 Get the report content ID [OUT].
 
void setRepID (uint32_t value)
 Set the report content ID [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 reportInfo method.

Member Function Documentation

◆ newId()

uint32_t newId ( ) const

Get the newest report item ID [OUT].

Returns
The parameter value

◆ numItems()

uint32_t numItems ( ) const

Get the No.of report items (in range from oldId to newId, all included) [OUT].

Returns
The parameter value

◆ oldId()

uint32_t oldId ( ) const

Get the oldest report item ID [OUT].

Returns
The parameter value

◆ repID()

uint32_t repID ( ) const

Get the report content ID [OUT].

Returns
The parameter value

◆ setNewId()

void setNewId ( uint32_t value)

Set the newest report item ID [OUT].

Parameters
valueThe value to set

◆ setNumItems()

void setNumItems ( uint32_t value)

Set the No.of report items (in range from oldId to newId, all included) [OUT].

Parameters
valueThe value to set

◆ setOldId()

void setOldId ( uint32_t value)

Set the oldest report item ID [OUT].

Parameters
valueThe value to set

◆ setRepID()

void setRepID ( uint32_t value)

Set the report content ID [OUT].

Parameters
valueThe value to set

◆ setSize()

void setSize ( uint32_t value)

Set the report size (no.of storable items) [OUT].

Parameters
valueThe value to set

◆ size()

uint32_t size ( ) const

Get the report size (no.of storable items) [OUT].

Returns
The parameter value