Extensions.DiagCom.GetParameterBySemantic

Classification

Name	GetParameterBySemantic
Short Description	Gets the parameter from a ParameterContainer and the semantic value
Class	Term
Extension	OTX DiagCom extension
Group	Parameter related terms
Exceptions	AmbiguousSemanticException
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

/// Local Declarations
DiagCom.Parameter ParameterVariable;
/// Flow
ParameterVariable = DiagCom.GetParameterBySemantic(ParameterContainerTerm, StringTerm);

Description

The GetParameterBySemantic term accepts a ParameterContainerTerm and the semantic value of the parameter to be retrieved. It can return simple type or complex type parameters, depending on the parameter structure of the diagnostic service definition of the underlying communication system and the specific parameter that is being retrieved.

In case a MVCI/ODX system is used the semantic value is equivalent to the semantic attribute of the corresponding MCDParameter object.

Return Value

The Term returns the value, see table below.

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

Data Type	Description
Parameter	The parameter is retrieved.

Properties

Name	Data Type	Class	Default	Cardinality	Description
ParameterContainer	ParameterContainer	Term	-	[1]	The container from which the Parameter shall be retrieved.
Semantic	String	Term	-	[1]	The semantic attribute of the Parameter which shall be returned.

OTL Examples

/// Local Declarations

DiagCom.Request Request1;
DiagCom.Parameter Parameter1;
DiagCom.ComChannel ComChannel1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "", false);
Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentBasicSettiStatu"));
Parameter1 = DiagCom.GetParameterBySemantic(Request1, "SERVICE-ID");

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
GetRequest
ExecuteDiagService
GetFirstResponse
GetAllResponses