Difference between revisions of "Extensions.DiagCom.ResultState"

Revision as of 12:29, 15 July 2014

ResultState is an enumeration type describing the state of a Result.

The list of allowed enumeration values is defined as follows:

Value	Literal	Description
ALL_FAILED	@ResultState:ALL_FAILED	All ECUs in a functional group (listening to the same functional address) failed to answer, in case of physical addressing: the one requested ECU failed to answer.
ALL_INVALID	@ResultState:ALL_INVALID	All ECUs in a functional group (listening to the same functional address) returned an invalid answer, in case of physical addressing: the one requested ECU returned an invalid response.
ALL_NEGATIVE	@ResultState:ALL_NEGATIVE	All ECUs in a functional group (listening to the same functional address) returned a negative response, in case of physical addressing: the one requested ECU returned a negative response.
ALL_POSITIVE	@ResultState:ALL_POSITIVE	All ECUs in a functional group (listening to the same functional address) returned a positive response, in case of physical addressing: the one requested ECU returned a positive response.
FAILED	@ResultState:FAILED	Some of the ECUs in a functional group (listening to the same functional address) failed to answer.
INVALID	@ResultState:INVALID	Some of the ECUs in a functional group (listening to the same functional address) returned an invalid response.
NEGATIVE	@ResultState:NEGATIVE	Some of the ECUs in a functional group (listening to the same functional address) returned a negative response.
POSITIVE	@ResultState:POSITIVE	Some of the ECUs in a functional group (listening to the same functional address) returned a positive response.

ResultState values may occur as operands of comparisons. For this case, the following order relation is defined:

ALL_FAILED < ALL_INVALID < ALL_NEGATIVE < ALL_POSITIVE < FAILED < INVALID < NEGA-TIVE < POSITIVE

The following table shows the rules for conversion of the data type to another data type:

Conversion	Result	Sample
ToBoolean	undefined, should not be used
ToInteger	Returns the index of the value in the ResultStates enumeration (smallest index is 0)	Integer val = ToInteger(@ResultState:ALL_FAILED) // Returns 0;
ToFloat	undefined, should not be used
ToString	Returns the name of the enumeration value	String s = ToString(@ResultState:ALL_FAILED) // Returns "ALL_FAILED";
ToByteField	undefined, should not be used

@@ Line 39: / Line 39: @@
-'''ResultState''' have the following semantic:
+==Conversion==
-* '''<init> : ResultStateLiteral [0..1]''' <br/> This optional element stands for the hard-coded initialisation value of the identifier at declaration time.
+The following table shows the rules for conversion of the data type to another data type:
-** '''value : ResultStates={ALL_FAILED|ALL_INVALID|ALL_NEGATIVE|ALL_POSITIVE|FAILED|INVALID|NEGATIVE|POSITIVE} [1]''' <br/> This attribute contain one of the values defined in the '''ResultStates''' enumeration.
+{| {{TableHeader}}
+|- {{TableHeaderRow}}
+| '''Conversion''' || '''Result''' || '''Sample'''
+|- {{TableRow1}}
+| '''ToBoolean''' || undefined, should not be used ||
+|- {{TableRow2}}
+| '''ToInteger''' || Returns the index of the value in the ResultStates enumeration (smallest index is 0) || <syntaxhighlight lang="java" enclose="div" style="font-size: medium;">Integer val = ToInteger(@ResultState:ALL_FAILED) // Returns 0;</syntaxhighlight>
+|- {{TableRow1}}
+| '''ToFloat''' || undefined, should not be used ||
+|- {{TableRow2}}
+| '''ToString''' || Returns the name of the enumeration value || <syntaxhighlight lang="java" enclose="div" style="font-size: medium;">String s = ToString(@ResultState:ALL_FAILED) // Returns "ALL_FAILED";</syntaxhighlight>
+|- {{TableRow1}}
+| '''ToByteField''' || undefined, should not be used ||
+|}