Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetTextTableElementLongNameID"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetTextTableElementLongNameID'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetTextTableElementLongNameID | UPDAT...")
 
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetTextTableElementLongNameID'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetTextTableElementLongNameID'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetTextTableElementLongNameID | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetTextTableElementLongNameID| Gets the long name ID of the [[Extensions.DiagDataBrowsingPlus.TextTableElement|TextTableElement]]| [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|TextTableElement related terms]] | NONE | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
UPDATING...<!--
 
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
DiagCom.CloseComChannel(ComChannelVariable);
+
StringTerm DiagDataBrowsingPlus.GetTextTableElementLongNameID(TextTableElementTerm textTableElement);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetTextTableElementLongNameID''' returns the ID for the LongName of the [[Extensions.DiagDataBrowsingPlus.TextTableElement|text table element]].
OTX CloseComChannel activity is used for the [[Diagnosis Runtime System]] to announce that an open communication channel that all relevant resources can be released and closed.
+
 
{{ComChannelMemoryUsageNote}}
+
{{Note|The appropriate MVCI system operation is MCDTextTableElement::getLongNameID}}
{{Important|Please note that the use of a shared '''ComChannel''' can bring the OTX runtime system in an undefined state and that is this case is not validated at design time!}}
+
 
-->
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Returns the ID for the LongName of the [[Extensions.DiagDataBrowsingPlus.TextTableElement|text table element]].}}
  
 
== Properties ==
 
== Properties ==
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| TextTableElement|[[Extensions.DiagDataBrowsingPlus.TextTableElement|TextTableElement]] | [[Term]] | - | [1..1] |The element addresses the '''TextTableElement''' (MCDTextTableElement) which long name ID shall be returned.}}
 
|}
 
|}
-->
 
  
 
== OTL Examples ==
 
== OTL Examples ==
UPDATING...<!--
 
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
DiagCom.ComChannel myComCannel;
+
/// Local Declarations
 +
 
 +
DiagCom.Parameter Parameter;
 +
DiagDataBrowsingPlus.DbParameter DbParameter;
 +
List<DiagDataBrowsingPlus.TextTableElement> List_TextTableElement;
 +
String MyString;
  
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
// Code example using the variable myComChannel
+
Parameter = DiagCom.GetParameterByPath(DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDataByIdentECUIdent")), {"Param_RecorDataIdent"});
// ...
+
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
List_TextTableElement = DiagDataBrowsingPlus.GetDbParameterTextTableElements(DbParameter);
 +
MyString = DiagDataBrowsingPlus.GetTextTableElementLongNameID(List_TextTableElement[0]);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== See also ==
 
== See also ==
UPDATING...
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
 +
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
 +
[[Extensions.DiagCom.GetFirstResponse|GetFirstResponse]] <br/>
 +
[[Extensions.DiagCom.GetRequest|GetRequest]] <br/>
 +
[[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]] <br/>
 +
[[Extensions.DiagCom.GetParameterBySemantic|GetParameterBySemantic]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetParameterDbParameter|GetParameterDbParameter]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbParameterTextTableElements|GetDbParameterTextTableElements]]

Latest revision as of 08:38, 2 November 2018

Classification

Name GetTextTableElementLongNameID
Short Description Gets the long name ID of the TextTableElement
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group TextTableElement related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm DiagDataBrowsingPlus.GetTextTableElementLongNameID(TextTableElementTerm textTableElement);

Description

GetTextTableElementLongNameID returns the ID for the LongName of the text table element.

Icons Note.png The appropriate MVCI system operation is MCDTextTableElement::getLongNameID

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 Returns the ID for the LongName of the text table element.

Properties

Name Data Type Class Default Cardinality Description
TextTableElement TextTableElement Term - [1..1] The element addresses the TextTableElement (MCDTextTableElement) which long name ID shall be returned.

OTL Examples

/// Local Declarations

DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;
List<DiagDataBrowsingPlus.TextTableElement> List_TextTableElement;
String MyString;

/// Flow

Parameter = DiagCom.GetParameterByPath(DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDataByIdentECUIdent")), {"Param_RecorDataIdent"});
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
List_TextTableElement = DiagDataBrowsingPlus.GetDbParameterTextTableElements(DbParameter);
MyString = DiagDataBrowsingPlus.GetTextTableElementLongNameID(List_TextTableElement[0]);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterBySemantic
GetParameterDbParameter
GetDbParameterTextTableElements