CanNmtWriteData Class Reference

The data for the canNmtWrite method. More...

#include <client.h>

Inheritance diagram for CanNmtWriteData:

Public Types
enum	CommandCodes {   cmdStart = 1 , cmdStop = 2 , cmdEnterPreoperational = 128 , cmdResetNode = 129 ,   cmdResetCommunication = 130 }
	NMT command code. More...

Public Member Functions
uint16_t	wsID () const
	Get the workstation ID [IN].
void	setWsID (uint16_t value)
	Set the workstation ID [IN].
uint16_t	numWs () const
	Get the number of workstation to write [1..63] [IN].
void	setNumWs (uint16_t value)
	Set the number of workstation to write [1..63] [IN].
CommandCodes	commandCode () const
	Get the NMT command code [IN].
void	setCommandCode (CommandCodes value)
	Set the NMT command code [IN].
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 canNmtWrite method.

See also

Client.canNmtWrite

Member Enumeration Documentation

CommandCodes

enum CommandCodes

NMT command code.

Enumerator
cmdStart	Start.
cmdStop	Stop.
cmdEnterPreoperational	Enter preoperational.
cmdResetNode	Reset node.
cmdResetCommunication	Reset communication.

Member Function Documentation

commandCode()

CommandCodes commandCode

(

)

const

Get the NMT command code [IN].

Returns

The parameter value

numWs()

ushort numWs

(

)

const

Get the number of workstation to write [1..63] [IN].

Returns

The parameter value

setCommandCode()

void setCommandCode

(

CommandCodes

value

)

Set the NMT command code [IN].

Parameters

value

The value to set

setNumWs()

void setNumWs

(

uint16_t

value

)

Set the number of workstation to write [1..63] [IN].

Parameters

value

The value to set

setWsID()

void setWsID

(

uint16_t

value

)

Set the workstation ID [IN].

Parameters

value

The value to set

Remarks

0 means all the workstations

wsID()

ushort wsID

(

)

const

Get the workstation ID [IN].

Returns

The parameter value

Remarks

0 means all the workstations