TranslatorSignalUserArray Class Reference

This class defines the API of the TranslatorSignalUserArray.

#include <translatorsignaluserarray.h>

Inheritance diagram for TranslatorSignalUserArray:

Public Slots
TranslatorSignal related functions.
virtual int	translate ()
	Translate the TX message in a dry run. Returns the complete length of the resulting part of the message.
uint32_t	getDimension ()
	Returns the current amount of elements.
TranslatorSignal *	getSignal (uint32_t uIndex)
	Gets the signal for the given index.
TranslatorSignal *	setSignal (TranslatorSignal *)
	Appends a signal.
TranslatorSignal *	setLengthFieldLength (uint8_t uLength)
	Sets the length of the length field.
TranslatorSignal *	setLength (uint32_t uLength)
	Sets the length in Bytes of the (fixed (without length field)) array.
TranslatorSignal *	setRxDimension (uint32_t uElements)
	Sets the RX dimension of the array (how many elements).
TranslatorSignal *	setTxDimension (uint32_t uElements)
	Sets the TX dimension of the array (how many elements).
virtual TranslatorSignal *	copyValue ()
	Copies the RX value to the TX value.
ScriptValue	getValue (unsigned int uValue)
	Returns the RX value for the given index.
ScriptValue	getValue (QString strValue)
	Returns the RX value for the given signal name.
virtual ScriptValue	getValue ()
	Is not supported on Struct. Returns the invalid (empty) value.
virtual TranslatorSignal *	setValue (ScriptValue svValue)
	Sets the TX value.
TranslatorSignal *	setValue (unsigned int uSignalIndex, ScriptValue svValue)
	Sets the TX value for the given index.
unsigned int	getSignalCount ()
	Returns the current length of the array.
virtual bool	isTxValid ()
	Returns true in case the value is valid.
Public Slots inherited from TranslatorSignalUser
virtual int	translate ()
	Translate the TX message in a dry run. Returns the complete length of the resulting part of the message.
bool	isHex ()
	Returns true in case of BigEndian.
bool	isDecimal ()
	Returns true in case of LittleEndian.
TranslatorSignalUser *	setHex ()
	Switches the signal to hexadecimal.
TranslatorSignalUser *	setDecimal ()
	Switches the signal to decimal.
virtual TranslatorSignal *	copyValue ()=0
	Copies the RX value to the TX value.
virtual ScriptValue	getValue ()=0
	Returns the RX value.
virtual TranslatorSignal *	setValue (ScriptValue svValue)=0
	Sets the TX value.
Public Slots inherited from TranslatorSignal
QString	getName ()
	Returns the name of the signal.
virtual int	translate ()
	Translate the TX message in a dry run. Returns the complete length of the resulting part of the message.
bool	isBigEndian ()
	Returns true in case of BigEndian.
bool	isLittleEndian ()
	Returns true in case of LittleEndian.
TranslatorSignal *	setBigEndian ()
	Switches the signal to BigEndian.
TranslatorSignal *	setLittleEndian ()
	Switches the signal to LittleEndian.
bool	valueHasChanged ()
	Returns true, if the RX value has been changed by the last message received.
virtual bool	isValid ()
	Returns true in case the value is valid.
virtual bool	isTxValid ()
	Returns true in case the value is valid.
virtual TranslatorSignal *	copyValue ()=0
	Copies the RX value to the TX value.
virtual ScriptValue	getValue ()=0
	Returns the RX value.
virtual TranslatorSignal *	setValue (ScriptValue svValue)=0
	Sets the TX value.
virtual TranslatorSignal *	suppress ()
	Suppress the output in the translated RX message. But the signal is read and written as normal.
virtual TranslatorSignal *	encourage ()
	Enables the output in the translated RX message. The opposite of the suppress function.

Additional Inherited Members
Public Member Functions inherited from TranslatorSignalUser
Public Member Functions inherited from TranslatorSignal
void	setRxValid (bool bValid)
	Sets the RX value to valid.
void	setTxValid (bool bValid)
	Sets the TX value to valid.
Public Attributes inherited from TranslatorSignal
Protected Attributes inherited from TranslatorSignal

Member Function Documentation

getSignal

TranslatorSignal * getSignal ( uint32_t uIndex )

slot

Parameters

uIndex

Gets the signal for the given index.

getValue [1/2]

ScriptValue getValue ( QString strValue )

slot

Parameters

strValue

Returns the RX value for the given signal name.

getValue [2/2]

ScriptValue getValue ( unsigned int uValue )

slot

Parameters

uValue

Returns the RX value for the given index.

setLength

TranslatorSignal * setLength ( uint32_t uLength )

slot

Parameters

uLength

Sets the length of the (fixed (without length field)) array.

setRxDimension

TranslatorSignal * setRxDimension ( uint32_t uElements )

slot

Set the RX dimension of the array.

Parameters

uElements

Returns

setTxDimension

TranslatorSignal * setTxDimension ( uint32_t uElements )

slot

Parameters

uElements

Sets the TX dimension of the array.

setValue [1/2]

TranslatorSignal * setValue ( ScriptValue svValue )

virtualslot

Parameters

svValue

Sets the TX value.

setValue [2/2]

TranslatorSignal * setValue ( unsigned int uSignalIndex, ScriptValue svValue )

slot

Parameters

svValue

Sets the TX value for the given index.