The data for Client.fbWriteEcatNmt method. More...

#include <client.h>

Inheritance diagram for FbWriteEcatNmtData:

Public Member Functions
Statuss	forcedStatus () const
	Get the forced status to write [IN/OUT].

void	setForcedStatus (Statuss value)
	Set the forced status to write [IN/OUT].

uint32_t	forcedTimeout () const
	Get the NMT force timeout [ms] to write [IN/OUT].

void	setForcedTimeout (uint32_t value)
	Set the NMT force timeout [ms] to write [IN/OUT].

Public Member Functions inherited from FbEcatNmtData
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].

Statuss	status () const

void	setStatus (Statuss value)
	Set the 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.

Additional Inherited Members
Public Types inherited from FbEcatNmtData
enum	Flagss { flagErrText = 0x40000000 , flagErrCode = 0x80000000 }
	Flags. More...

enum	Statuss { stsInit = 1 , stsPreOperational = 2 , stsBoot = 3 , SafeOperational = 4 , stsOperational = 8 }
	Nmt status. More...

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.

Static Protected Attributes inherited from FbEcatNmtData
static const Flagss	ResetErrMask = (Flagss)(flagErrText \| flagErrCode)
	Reset error flags mask.

static const Flagss	ResetMask = (Flagss)~ResetErrMask
	Reset normal flags mask.

Detailed Description

The data for Client.fbWriteEcatNmt method.

Member Function Documentation

◆ forcedStatus()

Statuss forcedStatus ( ) const

Get the forced status to write [IN/OUT].

Returns: The parameter value

Remarks: This field will be overwritten with the readout value on exit

◆ forcedTimeout()

uint32_t forcedTimeout ( ) const

Get the NMT force timeout [ms] to write [IN/OUT].

Returns: The parameter value

Remarks: This field will be overwritten with the readout value on exit

◆ setForcedStatus()

void setForcedStatus ( Statuss value )

Set the forced status to write [IN/OUT].

Parameters

value The value to set

Remarks: This field will be overwritten with the readout value on exit

◆ setForcedTimeout()

void setForcedTimeout ( uint32_t value )

Set the NMT force timeout [ms] to write [IN/OUT].