Difference between revisions of "Extensions.DiagDataBrowsingPlus.McdResponseType"

From emotive
Jump to navigation Jump to search
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:Data Type '''McdResponseType'''}}[[Category:DataType]][[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:Data Type '''McdResponseType'''}}[[Category:DataType]][[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationDataType | McdResponseType | is an enumeration type| [[Core.DataTypes.SimpleDataType|Simple Data Type]] | [[Core.DataTypes.SimpleDataType.SimpleType|SimpleType]] | DefaultValue=eGLOBAL_NEG_RESPONSET |- }}
+
{{ClassificationDataType | McdResponseType | is an enumeration type| [[Core.DataTypes.SimpleDataType|Simple Data Type]] | [[Core.DataTypes.SimpleDataType.SimpleType|SimpleType]] | DefaultValue=eGLOBAL_NEG_RESPONSET |Literal=Yes }}
  
 
== Description ==
 
== Description ==
 
'''McdResponseType''' is an enumeration type describing the ASAM types of responses used by the MVCI/ODX system.
 
'''McdResponseType''' is an enumeration type describing the ASAM types of responses used by the MVCI/ODX system.
 
Its members have the following semantics:
 
 
*<init> : diagDataPlus:McdResponseTypeLiteral[0..1]
 
 
This optional element stands for the hard-coded initialisation value of the identifier at declaration time.
 
  
 
'''McdResponseTypes''' has the following enumeration values:
 
'''McdResponseTypes''' has the following enumeration values:
Line 17: Line 11:
 
| '''Value''' || '''[[Literals|<span style="color:white;">Literal</span>]]''' || '''Description'''
 
| '''Value''' || '''[[Literals|<span style="color:white;">Literal</span>]]''' || '''Description'''
 
|- {{TableRow1}}
 
|- {{TableRow1}}
| '''eGLOBAL_NEG_RESPONSE''' || @McdResponseType:GLOBAL_NEG_RESPONSE || The response should match the negative response template at the Location
+
| '''eGLOBAL_NEG_RESPONSE''' || @McdResponseType:GLOBAL_NEG_RESPONSE || The response should match the negative response template at the Location (MCDResponseType::eGLOBAL_NEG_RESPONSE).  
(MCDResponseType::eGLOBAL_NEG_RESPONSE).  
 
 
|- {{TableRow2}}
 
|- {{TableRow2}}
| '''eLOCAL_NEG_RESPONSE''' || @McdResponseType:LOCAL_NEG_RESPONSE || The response should match the negative response template at the
+
| '''eLOCAL_NEG_RESPONSE''' || @McdResponseType:LOCAL_NEG_RESPONSE || The response should match the negative response template at the DiagComPrimitive (MCDResponseType::eLOCAL_NEG_RESPONSE).   
DiagComPrimitive (MCDResponseType::eLOCAL_NEG_RESPONSE).   
 
 
|- {{TableRow1}}
 
|- {{TableRow1}}
| '''ePOSITIVE_RESPONSE''' || @McdResponseType:POSITIVE_RESPONSE || The response should match the positive response template
+
| '''ePOSITIVE_RESPONSE''' || @McdResponseType:POSITIVE_RESPONSE || The response should match the positive response template (MCDResponseType::ePOSITIVE_RESPONSE).  
(MCDResponseType::ePOSITIVE_RESPONSE).  
 
 
|}
 
|}
  
 +
==Literal==
 +
The syntax for [[Literals| Literals for complex data types]] should be used, where the '''member value''' is one of the values in the list.
 +
 +
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 +
@McdResponseType:GLOBAL_NEG_RESPONSE|LOCAL_NEG_RESPONSE|POSITIVE_RESPONSE
 +
</syntaxhighlight>
  
 
{{ConversionTable |
 
{{ConversionTable |
Integer=Returns the index of the value in the enumeration (smallest index is 0).| IntegerSample=<tt>Integer i = ToInteger(McdResponseTypeVariable); // Returns the index of the value in the enumeration.</tt> |
+
Integer=Returns the index of the value in the enumeration (smallest index is 0).| IntegerSample=<tt>Integer i = ToInteger(@McdResponseType:GLOBAL_NEG_RESPONSE); // Returns 0 </tt> |
String=Returns the name of the enumeration value. | StringSample=<tt>String s = ToString(McdResponseTypeVariable); // Returns the name of the enumeration value.
+
String=Returns the name of the enumeration value. | StringSample=<tt>String s = ToString(@McdResponseType:GLOBAL_NEG_RESPONSE); // Returns "eGLOBAL_NEG_RESPONSE".
 
}}
 
}}
 +
 +
==Sample==
 +
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 +
DiagDataBrowsingPlus.McdResponseType McdResponseTypeVariable = @McdResponseType:GLOBAL_NEG_RESPONSE;
 +
</syntaxhighlight>

Latest revision as of 11:13, 19 October 2018

Classification

Name McdResponseType
Short Description is an enumeration type
Class Simple Data Type
Base Data Type SimpleType
Default Value eGLOBAL_NEG_RESPONSET
Provide a Literal Yes
SpecifiedBy ISO 13209-3
Standard Compliant Yes

Description

McdResponseType is an enumeration type describing the ASAM types of responses used by the MVCI/ODX system.

McdResponseTypes has the following enumeration values:

Value Literal Description
eGLOBAL_NEG_RESPONSE @McdResponseType:GLOBAL_NEG_RESPONSE The response should match the negative response template at the Location (MCDResponseType::eGLOBAL_NEG_RESPONSE).
eLOCAL_NEG_RESPONSE @McdResponseType:LOCAL_NEG_RESPONSE The response should match the negative response template at the DiagComPrimitive (MCDResponseType::eLOCAL_NEG_RESPONSE).
ePOSITIVE_RESPONSE @McdResponseType:POSITIVE_RESPONSE The response should match the positive response template (MCDResponseType::ePOSITIVE_RESPONSE).

Literal

The syntax for Literals for complex data types should be used, where the member value is one of the values in the list.

@McdResponseType:GLOBAL_NEG_RESPONSE|LOCAL_NEG_RESPONSE|POSITIVE_RESPONSE

Core Conversion

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

Conversion Result Sample
ToBoolean Undefined (should not be used)
ToInteger Returns the index of the value in the enumeration (smallest index is 0). Integer i = ToInteger(@McdResponseType:GLOBAL_NEG_RESPONSE); // Returns 0
ToFloat Undefined (should not be used)
ToString Returns the name of the enumeration value. String s = ToString(@McdResponseType:GLOBAL_NEG_RESPONSE); // Returns "eGLOBAL_NEG_RESPONSE".
ToByteField Undefined (should not be used)

Sample

DiagDataBrowsingPlus.McdResponseType McdResponseTypeVariable = @McdResponseType:GLOBAL_NEG_RESPONSE;