CanObjWriteData Class Reference

The data for the canObjWrite method. More...

#include <client.h>

Inheritance diagram for CanObjWriteData:

Public Types
enum	Types {   typeI8 = -1 , typeU8 = 1 , typeI16 = -2 , typeU16 = 2 ,   typeI24 = -3 , typeU24 = 3 , typeI32 = -4 , typeU32 = 4 ,   typeFloat = 5 }
	Data types. More...
enum	Flagss { flagErrorOnSDO = 0x00000001 }
	Reply 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	objectIndex () const
	Get the object index [IN].
void	setObjectIndex (uint16_t value)
	Set the object index [IN].
uint16_t	objectSubIndex () const
	Get the object sub-index [IN].
void	setObjectSubIndex (uint16_t value)
	Set the object sub-index [IN].
Types	type () const
	Get the object data type [IN].
void	setType (Types value)
	Set the object data type [IN].
double	data () const
	Get the data to write [IN].
void	setData (double value)
	Set the data to write [IN].
Flagss	flags () const
	Get the readout reply flags [IN].
void	setFlags (Flagss value)
	Set the readout reply flags [IN].
uint32_t	errorCode () const
	Get the readout error code (if flagss contains Flagss::flagErrorOnSDO) [OUT].
void	setErrorCode (uint32_t value)
	Set the readout error code (if flagss contains Flagss::flagErrorOnSDO) [OUT].
String &	errorText ()
	Get the readout error text (if flagss contains Flagss::flagErrorOnSDO) [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 canObjWrite method.

See also

Client.canObjWrite

Member Enumeration Documentation

Flagss

enum Flagss

Reply flags.

Enumerator
flagErrorOnSDO	Error on SDO.

Types

enum Types

Data types.

Enumerator
typeI8	8 bit signed
typeU8	Unsigned 8 bit.
typeI16	Signed 16 bit.
typeU16	Unigned 16 bit.
typeI24	Signed 24 bit.
typeU24	Unsigned 24 bit.
typeI32	Signed 32 bit.
typeU32	Unsigned 32 bit.
typeFloat	Float.

Member Function Documentation

data()

double data

(

)

const

Get the data to write [IN].

Returns

The parameter value

errorCode()

uint32_t errorCode

(

)

const

Get the readout error code (if flagss contains Flagss::flagErrorOnSDO) [OUT].

Returns

The parameter value

errorText()

String & errorText

(

)

Get the readout error text (if flagss contains Flagss::flagErrorOnSDO) [OUT].

Returns

The parameter value

flags()

Flagss flags

(

)

const

Get the readout reply flags [IN].

Returns

The parameter value

objectIndex()

ushort objectIndex

(

)

const

Get the object index [IN].

Returns

The parameter value

objectSubIndex()

ushort objectSubIndex

(

)

const

Get the object sub-index [IN].

Returns

The parameter value

setData()

void setData

(

double

value

)

Set the data to write [IN].

Parameters

value

The value to set

setErrorCode()

void setErrorCode

(

uint32_t

value

)

Set the readout error code (if flagss contains Flagss::flagErrorOnSDO) [OUT].

Parameters

value

The value to set

setFlags()

void setFlags

(

Flagss

value

)

Set the readout reply flags [IN].

Parameters

value

The value to set

setObjectIndex()

void setObjectIndex

(

uint16_t

value

)

Set the object index [IN].

Parameters

value

The value to set

setObjectSubIndex()

void setObjectSubIndex

(

uint16_t

value

)

Set the object sub-index [IN].

Parameters

value

The value to set

setType()

void setType

(

Types

value

)

Set the object data type [IN].

Parameters

value

The value to set

setWsID()

void setWsID

(

uint16_t

value

)

Set the workstation ID [IN].

Parameters

value

The value to set

type()

Types type

(

)

const

Get the object data type [IN].

Returns

The parameter value

wsID()

ushort wsID

(

)

const

Get the workstation ID [IN].

Returns

The parameter value