CanPdoReadData Class Reference

the data for the canRxPdoRead and canTxPdoRead method. More...

#include <client.h>

Inheritance diagram for CanPdoReadData:

Public Types
enum	Flagss { flagFromTxPdo = 0x00000001 , flagFromRxPdo = 0x00000002 }
	Flags. 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 No. of workstation (max 41) [IN].
void	setNumWs (uint16_t value)
	Set the No. of workstation (max 41) [IN].
uint16_t	pdoIndex () const
	Get the Pdo index [IN].
void	setPdoIndex (uint16_t value)
	Set the Pdo index [IN].
uint16_t	pdoItemIndex () const
	Get the Pdo item index [IN].
void	setPdoItemIndex (uint16_t value)
	Set the Pdo item index [IN].
CanPdoReadItem::Vector &	items ()
	Get the result list of read items. [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 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 canRxPdoRead and canTxPdoRead method.

Member Enumeration Documentation

Flagss

enum Flagss

Flags.

Enumerator
flagFromTxPdo	Read Tx Pdo.
flagFromRxPdo	Read Rx Pdo.

Member Function Documentation

items()

CanPdoReadItem::Vector & items

(

)

Get the result list of read items. [OUT].

Returns

The parameter value

numWs()

ushort numWs

(

)

const

Get the No. of workstation (max 41) [IN].

Returns

The parameter value

pdoIndex()

ushort pdoIndex

(

)

const

Get the Pdo index [IN].

Returns

The parameter value

pdoItemIndex()

ushort pdoItemIndex

(

)

const

Get the Pdo item index [IN].

Returns

The parameter value

setNumWs()

void setNumWs

(

uint16_t

value

)

Set the No. of workstation (max 41) [IN].

Parameters

value

The value to set

setPdoIndex()

void setPdoIndex

(

uint16_t

value

)

Set the Pdo index [IN].

Parameters

value

The value to set

setPdoItemIndex()

void setPdoItemIndex

(

uint16_t

value

)

Set the Pdo item index [IN].

Parameters

value

The value to set

setWsID()

void setWsID

(

uint16_t

value

)

Set the workstation ID [IN].

Parameters

value

The value to set

wsID()

ushort wsID

(

)

const

Get the workstation ID [IN].

Returns

The parameter value