Extensions.DiagCom.GetParameterBySemantic

From emotive
Revision as of 02:31, 15 February 2016 by Hb (talk | contribs)
Jump to navigation Jump to search

Classification

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

OTL Syntax

ParameterTerm = DiagCom.GetParameterBySemantic(ParameterContainer, StringTerm);

Description

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

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
Parameter Parameter object.

Properties

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").

OTL Examples

DiagCom.Parameter Parameter1;
DiagCom.DiagService DiagService1;
DiagCom.ComChannel ComChannel1;

ComChannel1 = DiagCom.GetComChannel("LL_AirbaUDS", null, false);
DiagService1 = DiagCom.CreateDiagServiceBySemantic(ComChannel1, "DEFAULT-FAULT-READ");
Parameter1 = DiagCom.GetParameterBySemantic(DiagCom.GetRequest(DiagService1), "SERVICE-ID");

See also

GetParameterByPath
GetParameterName
GetParameterSemantic
GetParameterTextId
GetParameterAsList
ExecuteDiagService