FbEntryData Class Reference

The data for Client.doFbReadEntry and Client.doFbWriteEntry method. More...

#include <client.h>

Inheritance diagram for FbEntryData:

Public Types
enum	Flagss {   flagAddr = 0x00000001 , flagDefValue = 0x00000002 , flagMinValue = 0x00000004 , flagMaxValue = 0x00000008 ,   flagText = 0x00000010 , flagErrText = 0x40000000 , flagErrCode = 0x80000000 }
	Flags. More...
enum	DataTypesFlagss {   dtFlagI8 = 0x00000001 , dtFlagU16 = 0x00000002 , dtFlagU32 = 0x00000004 , dtFlagU64 = 0x00000008 ,   dtFlagSigned = 0x00000010 , dtFlagFloatingPoint = 0x00000020 , dtFlagRecord = 0x00000040 , dtFlagFlash = 0x00000080 ,   dtFlagReadable = 0x00000100 , dtFlagWritable = 0x00000200 , dtFlagPreOperationalOnly = 0x00000400 , dtFlagIGBTBridgeDisabledOnly = 0x00000800 ,   dtFlagPDOMappable = 0x00001000 , dtFlagWriteSpecialHandling = 0x00002000 , dtFlagStringZ = 0x00100000 }
	Entry data types for filedbus flags. More...

Public Member Functions
uint32_t	node () const
	Get the node address [IN].
void	setNode (uint32_t value)
	Set the node address [IN].
uint32_t	index () const
	Get the entry index [IN].
void	setIndex (uint32_t value)
	Set the entry index [IN].
uint32_t	subIndex () const
	Get the entry subindex [IN].
void	setSubIndex (uint32_t value)
	Set the entry subindex [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].
DataTypesFlagss	dataTypesFlags () const
	Get the readout data type [OUT].
void	setDataTypesFlags (DataTypesFlagss value)
	Set the readout data type [OUT].
String &	dataText ()
	Get the readout string data type or data text [OUT].
double	value () const
	Get the readout data or data to write [OUT].
void	setValue (double value)
	Set the readout data or data to write [OUT].
uint32_t	addr () const
	Get the readout address [OUT].
void	setAddr (uint32_t value)
	Set the readout address [OUT].
double	defValue () const
	Get the readout default value [OUT].
void	setDefValue (double value)
	Set the readout default value [OUT].
double	minValue () const
	Get the readout minimum value [OUT].
void	setMinValue (double value)
	Set the readout minimum value [OUT].
double	maxValue () const
	Get the readout maximum value [OUT].
void	setMaxValue (double value)
	Set the readout maximum value [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	ResetMask = (Flagss)(flagAddr | flagDefValue | flagMinValue | flagMaxValue | flagText)
	Reset normal flags mask.
static const Flagss	ResetErrMask = (Flagss)(flagErrText | flagErrCode)
	Reset error 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 data for Client.doFbReadEntry and Client.doFbWriteEntry method.

Member Enumeration Documentation

DataTypesFlagss

enum DataTypesFlagss

Entry data types for filedbus flags.

Enumerator
dtFlagI8	8bit data
dtFlagU16	16bit data
dtFlagU32	32bit data
dtFlagU64	64bit data
dtFlagSigned	Signed data (otherwise unsigned data)
dtFlagFloatingPoint	Floating point data(otherwise fixed data)
dtFlagRecord	Record.
dtFlagFlash	Type parameter to be stored in flash.
dtFlagReadable	Object readable.
dtFlagWritable	Object writable.
dtFlagPreOperationalOnly	Only in pre - operational mode.
dtFlagIGBTBridgeDisabledOnly	Only with IGBT bridge disabled.
dtFlagPDOMappable	Object can be mapped in PDO area.
dtFlagWriteSpecialHandling	Object write require special handling(not all values in range are valid)
dtFlagStringZ	Object is a 0 - termined string.

Flagss

enum Flagss

Flags.

Enumerator
flagAddr	Address field.
flagDefValue	Default value field.
flagMinValue	Minimum value field.
flagMaxValue	Maximum value field.
flagText	Text field.
flagErrText	Error text field.
flagErrCode	Error code field.

Member Function Documentation

addr()

uint32_t addr

(

)

const

Get the readout address [OUT].

Returns

The parameter value

Remarks

Meaningfull only if dataTypesFlags has the DataTypesFlagss::dtFlagStringZ bit NOT setted and if the readout flags has the Flagss::flagAddr bit setted

dataText()

String & dataText

(

)

Get the readout string data type or data text [OUT].

Returns

The parameter value

Remarks

Meaningfull only if dataTypesFlags has the DataTypesFlagss::dtFlagStringZ bit setted or if the readout flags has the Flagss::flagText"/> bit setted

dataTypesFlags()

DataTypesFlagss dataTypesFlags

(

)

const

Get the readout data type [OUT].

Returns

The parameter value

defValue()

double defValue

(

)

const

Get the readout default value [OUT].

Returns

The parameter value

Remarks

Meaningfull only if dataTypesFlags has the DataTypesFlagss::dtFlagStringZ bit NOT setted and if the readout flags has the Flagss::flagDefValue bit setted

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

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

index()

uint32_t index

(

)

const

Get the entry index [IN].

Returns

The parameter value

maxValue()

double maxValue

(

)

const

Get the readout maximum value [OUT].

Returns

The parameter value

Remarks

Meaningfull only if dataTypesFlags has the DataTypesFlagss::dtFlagStringZ bit NOT setted and if the readout flags has the Flagss::flagMaxValue bit setted

minValue()

double minValue

(

)

const

Get the readout minimum value [OUT].

Returns

The parameter value

Remarks

Meaningfull only if dataTypesFlags has the DataTypesFlagss::dtFlagStringZ bit NOT setted and if the readout flags has the Flagss::flagMinValue bit setted

node()

uint32_t node

(

)

const

Get the node address [IN].

Returns

The parameter value

setAddr()

void setAddr

(

uint32_t

value

)

Set the readout address [OUT].

Parameters

value

The value to set

Remarks

Meaningfull only if dataTypesFlags has the DataTypesFlagss::dtFlagStringZ bit NOT setted and if the readout flags has the Flagss::flagAddr bit setted

setDataTypesFlags()

void setDataTypesFlags

(

DataTypesFlagss

value

)

Set the readout data type [OUT].

Parameters

value

The value to set

setDefValue()

void setDefValue

(

double

value

)

Set the readout default value [OUT].

Parameters

value

The value to set

Remarks

Meaningfull only if dataTypesFlags has the DataTypesFlagss::dtFlagStringZ bit NOT setted and if the readout flags has the Flagss::flagDefValue bit setted

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

setIndex()

void setIndex

(

uint32_t

value

)

Set the entry index [IN].

Parameters

value

The value to set

setMaxValue()

void setMaxValue

(

double

value

)

Set the readout maximum value [OUT].

Parameters

value

The value to set

Remarks

Meaningfull only if dataTypesFlags has the DataTypesFlagss::dtFlagStringZ bit NOT setted and if the readout flags has the Flagss::flagMaxValue bit setted

setMinValue()

void setMinValue

(

double

value

)

Set the readout minimum value [OUT].

Parameters

value

The value to set

Remarks

Meaningfull only if dataTypesFlags has the DataTypesFlagss::dtFlagStringZ bit NOT setted and if the readout flags has the Flagss::flagMinValue bit setted

setNode()

void setNode

(

uint32_t

value

)

Set the node address [IN].

Parameters

value

The value to set

setSubIndex()

void setSubIndex

(

uint32_t

value

)

Set the entry subindex [IN].

Parameters

value

The value to set

setValue()

void setValue

(

double

value

)

Set the readout data or data to write [OUT].

Parameters

value

The value to set

Remarks

Meaningfull only if dataTypesFlags has the DataTypesFlagss::dtFlagStringZ bit NOT setted

subIndex()

uint32_t subIndex

(

)

const

Get the entry subindex [IN].

Returns

The parameter value

value()

double value

(

)

const

Get the readout data or data to write [OUT].

Returns

The parameter value

Remarks

Meaningfull only if dataTypesFlags has the DataTypesFlagss::dtFlagStringZ bit NOT setted

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)(flagAddr | flagDefValue | flagMinValue | flagMaxValue | flagText)

staticprotected

Reset normal flags mask.