GetTranslation¶
-
virtual std::string ISignal::GetTranslation(uint32_t value) = 0¶
Gets the translation of the specified signal value into a human-readable string representation.
- Parameters
value – Signal value to be translated.
- Returns
std::string – String representation for the specified signal value.
- Throws
CInvalidArgumentException
– Invalid value specified (i.e. enum or mask value does not exist).CUnsupportedException
– GetTranslation not supported (signal data type must be ESignalDataType::Bool, ESignalDataType::Enum or ESignalDataType::Mask).CCommunicationErrorException
– Protocol error.CConnectionLostException
– Connection to controller lost.CRebootedException
– Controller has been rebooted since this object reference was retrieved, invalidating this reference.
- Remarks
Meant for:
Booleans, i.e. “True” or “False”
Enumerations, i.e. translates enumerator into name
Masks, i.e. translates mask value into name.