Difference between revisions of "Extensions.DiagCom.GetParameterName"

From emotive
Jump to navigation Jump to search
 
(4 intermediate revisions by one other user not shown)
Line 5: Line 5:
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
StringTerm = DiagCom.GetParameterName(ParameterTerm);
+
StringTerm DiagCom.GetParameterName(ParameterTerm parameter);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 18: Line 18:
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | The '''Parameter''' whose name shall be returned.}}
+
{{TableRowPropertie2| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | The '''Parameter''' whose name will be returned.}}
 
|}
 
|}
  
 
== OTL Examples ==
 
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 +
/// Local Declarations
 +
 
DiagCom.Request Request1;
 
DiagCom.Request Request1;
 
String String1 = "";
 
String String1 = "";

Latest revision as of 10:14, 12 September 2019

Classification

Name GetParameterName
Short Description Gets the name of the parameter
Class Term
Extension OTX DiagCom extension
Group Parameter related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm DiagCom.GetParameterName(ParameterTerm parameter);

Description

The GetParameterName term accepts a ParameterTerm and returns the name of the parameter.

Icons Note.png In case a MVCI/ODX system is used it returns the SHORT-NAME of the corresponding MCDParameter object.

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
String the name of the parameter.

Properties

Name Data Type Class Default Cardinality Description
Parameter Parameter Term - [1] The Parameter whose name will be returned.

OTL Examples

/// Local Declarations

DiagCom.Request Request1;
String String1 = "";
DiagCom.ComChannel ComChannel1;
DiagCom.Parameter Parameter1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_GatewUDS", "EV_GatewLear_006", false);
Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(ComChannel1, "SinglJob_FlashProgr"));
Parameter1 = DiagCom.GetParameterByPath(Request1, {"IPA_STminHandl"});
String1 = DiagCom.GetParameterName(Parameter1);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
GetRequest
ExecuteDiagService
GetFirstResponse
GetAllResponses
GetParameterBySemantic
GetParameterByPath
GetParameterAsList