Difference between revisions of "Extensions.DiagCom.GetParameterBySemantic"

Revision as of 02:48, 18 July 2014

Name	GetParameterBySemantic
Short Description	Returns a parameter whose semantic attribute
Class	Term
Extension	OTX DiagCom extension
Group	Parameter related terms
Exceptions	AmbiguousSemanticException
Checker Rules	-
Standard Compliant	Yes

Parameter GetParameterBySemantic(ParameterContainer container, String semantic);

The GetParameterBySemantic term is from a container parameters to the corresponding parameter. The parameter is a Semantic Attribute selected.

The Term returns the value, see table below.

In OTX, Terms are categorized according to its return data type!

Data Type	Description
Parameter	Parameter object.

Name	Data Type	Class	Default	Cardinality	Description
ParameterContainer	ParameterContainer	Term	-	[1]	Container, which is read out from the parameter.
Semantic	String	Term	""	[1]	Semantic attribute to classify the diagnostic services (eg: "DEFAULT FAULTREAD" or "IDENTIFICATION").

Parameter result = GetParameterBySemantic(container, "IDENTIFICATION");

@@ Line 5: / Line 5: @@
 == Pseudo-Code Syntax ==
 <syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
-GetParameterBySemantic(ParameterContainer container, String semantic, Parameter result);
+Parameter GetParameterBySemantic(ParameterContainer container, String semantic);
 </syntaxhighlight>