Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbObjectDescriptionID"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbObjectDescriptionID'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbObjectDescriptionID | UPDATING... | [...")
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbObjectDescriptionID'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbObjectDescriptionID'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbObjectDescriptionID | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbObjectDescriptionID | Gets the description ID of the [[Extensions.DiagDataBrowsingPlus.DbObject|DbObject]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|DbObject 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.GetDbObjectDescriptionID(DbObjectTerm dbObject);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbObjectDescriptionID''' returns the ID for the Description of the object as a [[Core.DataTypes.SimpleDataType.String|string]] which is made for multi language purposes. It returns the ID for a text in a texttable, in each language texttable the ID points to the same content but different language. The return value can be empty, if the ID can not be determined.
−
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 MCDDbObject::getDescriptionID}}
−
{{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 Description of the object}}
  
 
== Properties ==
 
== Properties ==
−
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| DbObject | [[Extensions.DiagDataBrowsingPlus.DbObject|DbObject]] | [[Term]] | - | [1..1] |The element addresses the '''DbObject''' whose description 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
 +
 
 +
String MyString;
 +
DiagDataBrowsingPlus.DbComChannel dbObject;
  
−
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
−
// Code example using the variable myComChannel
+
dbObject = DiagDataBrowsingPlus.GetDbComChannel("EV_ACCBOSCHAU65X_001", "LL_AdaptCruisContrUDS");
−
// ...
+
MyString = DiagDataBrowsingPlus.GetDbObjectDescriptionID(dbObject);
−
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
 
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== See also ==
 
== See also ==
−
UPDATING...
+
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDiagServiceDbDiagService|GetDiagServiceDbDiagService]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetParameterDbDiagTroubleCode|GetParameterDbDiagTroubleCode]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbEnvDataDescs|GetDbComChannelDbEnvDataDescs]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbFaultMemories|GetDbComChannelDbFaultMemories]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbParameters|GetDbParameters]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetRequestDbRequest|GetRequestDbRequest]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetResponseDbResponse|GetResponseDbResponse]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbDiagServiceDbSpecialDataGroups|GetDbDiagServiceDbSpecialDataGroups]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbSubComponents|GetDbComChannelDbSubComponents]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbTables|GetDbComChannelDbTables]]

Latest revision as of 09:07, 2 November 2018

Classification

Name GetDbObjectDescriptionID
Short Description Gets the description ID of the DbObject
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbObject related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm DiagDataBrowsingPlus.GetDbObjectDescriptionID(DbObjectTerm dbObject);

Description

GetDbObjectDescriptionID returns the ID for the Description of the object as a string which is made for multi language purposes. It returns the ID for a text in a texttable, in each language texttable the ID points to the same content but different language. The return value can be empty, if the ID can not be determined.

Icons Note.png The appropriate MVCI system operation is MCDDbObject::getDescriptionID

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 Description of the object

Properties

Name Data Type Class Default Cardinality Description
DbObject DbObject Term - [1..1] The element addresses the DbObject whose description ID shall be returned.

OTL Examples

/// Local Declarations

String MyString;
DiagDataBrowsingPlus.DbComChannel dbObject;

/// Flow

dbObject = DiagDataBrowsingPlus.GetDbComChannel("EV_ACCBOSCHAU65X_001", "LL_AdaptCruisContrUDS");
MyString = DiagDataBrowsingPlus.GetDbObjectDescriptionID(dbObject);

See also

GetDbComChannel
GetDiagServiceDbDiagService
GetParameterDbDiagTroubleCode
GetDbComChannelDbEnvDataDescs
GetDbComChannelDbFaultMemories
GetDbParameters
GetRequestDbRequest
GetResponseDbResponse
GetDbDiagServiceDbSpecialDataGroups
GetDbComChannelDbSubComponents
GetDbComChannelDbTables

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.DiagDataBrowsingPlus.GetDbObjectDescriptionID&oldid=8977"