kbLogger 2.0.b1
The automotive ready test and logging program.
List of all members
TranslatorSignalUserString Class Reference

This class defines the API of the TranslatorSignalUserString.

#include <translatorsignaluserstring.h>

Inheritance diagram for TranslatorSignalUserString:
TranslatorSignalUser TranslatorSignal

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.
 
TranslatorSignal * setBomUsage (bool bBomUsage)
 Sets the usage of BOM.
 
TranslatorSignal * setStringType (StringType_t eStringType)
 Sets the string type.
 
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)) string.
 
virtual TranslatorSignal * copyValue ()
 Copies the RX value to the TX value.
 
virtual ScriptValue getValue ()
 Returns the RX value.
 
virtual TranslatorSignal * setValue (ScriptValue svValue)
 Sets the TX value.
 
- 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

◆ setBomUsage

TranslatorSignal * setBomUsage ( bool bBomUsage)
slot
Parameters
bBomUsageSets the usage of BOM.

◆ setLength

TranslatorSignal * setLength ( uint32_t uLength)
slot
Parameters
uLengthSets the length of the (fixed (without length field)) string.

◆ setValue

TranslatorSignal * setValue ( ScriptValue svValue)
virtualslot
Parameters
svValueSets the TX value.