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

The data for the Monitor::error signal. More...

#include <monitor.h>

Inheritance diagram for ErrorData:
ErrorData

Public Member Functions

 ErrorData (const ErrorData &src)
 Copy constructor.
 
 ErrorData (Globals::Results result=Globals::resSuccess, Message *src=nullptr)
 Class constructor.
 
Globals::Results result () const
 Get the result code.
 
void setResult (Globals::Results value)
 
- 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

- 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 Monitor::error signal.

Constructor & Destructor Documentation

◆ ErrorData() [1/2]

ErrorData ( const ErrorData & src)

Copy constructor.

Parameters
srcThe source object.

◆ ErrorData() [2/2]

ErrorData ( Globals::Results result = Globals::resSuccess,
Message * src = nullptr )

Class constructor.

Parameters
resultThe result code.
srcThe source message containing the error (optional).

Member Function Documentation

◆ result()

Globals::Results result ( ) const

Get the result code.

Returns
The parameter value

◆ setResult()

void setResult ( Globals::Results value)