FbNmtData Class Reference

The base data for Client.doFbReadNmt and Client.doFbWriteNmt method. More...

#include <client.h>

Inheritance diagram for FbNmtData:

Public Types
enum	Flagss { flagErrText = 0x40000000 , flagErrCode = 0x80000000 }
	Flags. More...
enum	Statuss { stsInit = 0 , stsPreOperational = 1 , stsOperational = 2 }
	Nmt status. More...

Public Member Functions
uint32_t	node () const
	Get the node address [IN].
void	setNode (uint32_t value)
	Set the node address [IN].
Flagss	flags () const
	Get the flags [IN/OUT].
void	setFlags (Flagss value)
	Set the flags [IN/OUT].
uint32_t	errorCode () const
	Get the readout error code [OUT].
void	setErrorCode (uint32_t value)
	Set the readout error code [OUT].
String &	errorText ()
	Get the readout error text [OUT].
Statuss	status () const
	Get the readout error status [OUT].
void	setStatus (Statuss value)
	Set the readout error status [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.

Static Protected Attributes
static const Flagss	ResetErrMask = (Flagss)(flagErrText | flagErrCode)
	Reset error flags mask.
static const Flagss	ResetMask = (Flagss)~ResetErrMask
	Reset normal flags mask.

Friends
class	RLibCpp::Bcc::Client

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 base data for Client.doFbReadNmt and Client.doFbWriteNmt method.

Member Enumeration Documentation

Flagss

enum Flagss

Flags.

Enumerator
flagErrText	Error text field.
flagErrCode	Error code field.

Statuss

enum Statuss

Nmt status.

Enumerator
stsInit	Init.
stsPreOperational	PreOperational.
stsOperational	Operational.

Member Function Documentation

errorCode()

uint32_t errorCode

(

)

const

Get the readout error code [OUT].

Returns

The parameter value

errorText()

String & errorText

(

)

Get the readout error text [OUT].

Returns

The parameter value

Remarks

Meaningfull only if errorCode !=0 and flags has the Flagss::flagErrText bit setted

flags()

Flagss flags

(

)

const

Get the flags [IN/OUT].

Returns

The parameter value

Remarks

This field will be overwritten with the readout value on exit

node()

uint32_t node

(

)

const

Get the node address [IN].

Returns

The parameter value

setErrorCode()

void setErrorCode

(

uint32_t

value

)

Set the readout error code [OUT].

Parameters

value

The value to set

setFlags()

void setFlags

(

Flagss

value

)

Set the flags [IN/OUT].

Parameters

value

The value to set

Remarks

This field will be overwritten with the readout value on exit

setNode()

void setNode

(

uint32_t

value

)

Set the node address [IN].

Parameters

value

The value to set

setStatus()

void setStatus

(

Statuss

value

)

Set the readout error status [OUT].

Parameters

value

The value to set

status()

Statuss status

(

)

const

Get the readout error status [OUT].

Returns

The parameter value

Friends And Related Symbol Documentation

RLibCpp::Bcc::Client

friend class RLibCpp::Bcc::Client

friend

Member Data Documentation

ResetErrMask

const Flagss ResetErrMask = (Flagss)(flagErrText | flagErrCode)

staticprotected

Reset error flags mask.

ResetMask

const Flagss ResetMask = (Flagss)~ResetErrMask

staticprotected

Reset normal flags mask.