ErrorData Class Reference

The base error data for all client, monitor and oscilloscope operations. More...

#include <client.h>

Inheritance diagram for ErrorData:

Public Member Functions
	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.

Protected Member Functions
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 base error data for all client, monitor and oscilloscope operations.

Constructor & Destructor Documentation

ErrorData()

ErrorData

(

)

Class contructor.

Member Function Documentation

clearError()

void clearError

(

)

Clear the error information.

nackErrCode()

Message::ErrCodes nackErrCode

(

)

const

Get the received NACK error code : if the value equals Message::errCodesNoError then no NACK message was received.

Returns

The parameter value

nackErrExtra()

uint16_t nackErrExtra

(

)

const

Get the optional error extra data of the last NACK message received from the remote device.

Returns

The parameter value

nackErrFlags()

uint16_t nackErrFlags ( ) const

protected

Get the error information validity flags.

Returns

The parameter value

setError() [1/2]

void setError

(

Message::ErrCodes

errCode

)

Set the error information.

Parameters

errCode

The error code

setError() [2/2]

void setError	(	Message::ErrCodes	errCode,
		uint16_t	errExtra )

Set the error information.

Parameters

errCode	The error code
errExtra	The error extra data.

setErrorFromMessage()

void setErrorFromMessage

(

Message *

src

)

Set error information from a source message.

Parameters

src	The source message (can be null).

setNackErrCode()

void setNackErrCode ( Message::ErrCodes value )

protected

Set the received NACK error code : if the value equals Message::errCodesNoError then no NACK message was received.

Parameters

value

The value to set

setNackErrExtra()

void setNackErrExtra ( uint16_t value )

protected

Set the optional error extra data of the last NACK message received from the remote device.

Parameters

value

The value to set

setNackErrFlags()

void setNackErrFlags ( uint16_t value )

protected

Set the error information validity flags.

Parameters

value

The value to set