Difference between revisions of "Extensions.DiagCom.GetParameterTextId"

From emotive
Jump to navigation Jump to search
(Created page with "Category:DiagCom == Classification == {{ClassificationActivity | GetParameterTextId | The text id of the parameter | Term | OTX DiagCom extension | Param...")
 
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
[[Category:DiagCom]]
+
{{DISPLAYTITLE:OTX '''GetParameterTextId'''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetParameterTextId | The text id of the parameter | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | - | - }}
+
{{ClassificationActivity | GetParameterTextId | Gets the text id attribute of the parameter | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Terms|Parameter related terms]] | - | - }}
  
−
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
GetParameterTextId(Parameter parameter, String parameterTextId);
+
StringTerm DiagCom.GetParameterTextId(ParameterTerm parameter);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The '''GetParameterTextId''' term accepts a [[ParameterTerm]] and returns the text id of the [[Parameter]].
+
The '''GetParameterTextId''' term accepts a '''ParameterTerm''' and returns the text id of the [[Extensions.DiagCom.Parameter|Parameter]].
  
−
{{TermReturnValue| [[String]] | The text id of the parameter.}}
+
{{Note|In case a MVCI/ODX system is used it returns the '''LongNameId''' attribute of the corresponding '''MCDDbObject''' object. In case the parameter represents a DTC, the '''DiagTroubleCodeTextID''' of the '''MCDDbDiagTroubleCode''' is returned.}}
 +
 
 +
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The text id of the parameter.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| Parameter | [[Parameter]] | [[Term]] | - | [1] | The [[Parameter]] object.}}
+
{{TableRowPropertie2| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] |The '''Parameter''' whose text id attribute will be returned.}}
 
|}
 
|}
  
−
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
String parameterTextId = GetParameterTextId(parameter);
+
/// 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, "DiagnServi_ReadDataByIdentVWSlaveCodinValue"));
 +
Parameter1 = DiagCom.GetParameterByPath(Request1, {"Param_RequeServiId"});
 +
String1 = DiagCom.GetParameterTextId(Parameter1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
−
[[GetParameterName]] <br/>
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
−
[[GetParameterSemantic]] <br/>
+
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
−
[[GetParameterByPath]] <br/>
+
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
−
[[GetParameterValue]] <br/>
+
[[Extensions.DiagCom.GetRequest|GetRequest]] <br/>
−
[[GetParameterAsList]] <br/>
+
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
−
[[ExecuteDiagService]]
+
[[Extensions.DiagCom.GetFirstResponse|GetFirstResponse]] <br/>
 +
[[Extensions.DiagCom.GetAllResponses|GetAllResponses]] <br/>
 +
[[Extensions.DiagCom.GetParameterBySemantic|GetParameterBySemantic]] <br/>
 +
[[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]] <br/>
 +
[[Extensions.DiagCom.GetParameterAsList|GetParameterAsList]]<br/>
 +
[[Extensions.DiagCom.GetParameterSemantic|GetParameterSemantic]] <br/>

Latest revision as of 10:15, 12 September 2019

Classification

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

OTL Syntax

StringTerm DiagCom.GetParameterTextId(ParameterTerm parameter);

Description

The GetParameterTextId term accepts a ParameterTerm and returns the text id of the Parameter.

Icons Note.png In case a MVCI/ODX system is used it returns the LongNameId attribute of the corresponding MCDDbObject object. In case the parameter represents a DTC, the DiagTroubleCodeTextID of the MCDDbDiagTroubleCode is returned.

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 text id of the parameter.

Properties

Name Data Type Class Default Cardinality Description
Parameter Parameter Term - [1] The Parameter whose text id attribute 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, "DiagnServi_ReadDataByIdentVWSlaveCodinValue"));
Parameter1 = DiagCom.GetParameterByPath(Request1, {"Param_RequeServiId"});
String1 = DiagCom.GetParameterTextId(Parameter1);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
GetRequest
ExecuteDiagService
GetFirstResponse
GetAllResponses
GetParameterBySemantic
GetParameterByPath
GetParameterAsList
GetParameterSemantic

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.DiagCom.GetParameterTextId&oldid=9685"