Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbObjectDescription"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbObjectDescription'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbObjectDescription | UPDATING... | Ter...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbObjectDescription'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbObjectDescription'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbObjectDescription | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbObjectDescription | Gets the description of the [[Extensions.DiagDataBrowsingPlus.dbObject|dbObject]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|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.GetDbObjectDescription(DbObjectTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbObjectDescription''' returns the Description of the [[Extensions.DiagDataBrowsingPlus.dbObject|dbObject] which can also be empty (Description is not mandatory).
−
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|NOTE — The appropriate MVCI system operation is MCDNamedObject::getDescription}}
−
{{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 Description of the [[Extensions.DiagDataBrowsingPlus.dbObject|dbObject].}}
  
 
== 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 [[Extensions.DiagDataBrowsingPlus.dbObject|dbObject] whose description  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;
+
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.GetDbObjectDescription(dbObject);
−
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
 
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== See also ==
 
== See also ==
−
UPDATING...
+
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.DbDiagTroubleCode|DbDiagTroubleCode]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.DbEnvDataDesc|DbEnvDataDesc]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.DbFaultMemory|DbFaultMemory]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.DbRequest|DbRequest]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.DbResponse|DbResponse]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.DbSpecialDataGroup|DbSpecialDataGroup]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.DbSubComponent|DbSubComponent]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.DbTable|DbTable]]

Revision as of 05:06, 12 September 2018

Classification

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

OTL Syntax

StringTerm = DiagDataBrowsingPlus.GetDbObjectDescription(DbObjectTerm);

Description

GetDbObjectDescription returns the Description of the [[Extensions.DiagDataBrowsingPlus.dbObject|dbObject] which can also be empty (Description is not mandatory).

Icons Note.png NOTE — The appropriate MVCI system operation is MCDNamedObject::getDescription

{{TermReturnValue| String | Returns Description of the [[Extensions.DiagDataBrowsingPlus.dbObject|dbObject].}}

Properties

Name Data Type Class Default Cardinality Description

{{TableRowPropertie2| dbObject | [[Extensions.DiagDataBrowsingPlus.dbObject|dbObject] | Term | - | [1..1] |The element addresses the [[Extensions.DiagDataBrowsingPlus.dbObject|dbObject] whose description shall be returned.}}

OTL Examples

String MyString;
DiagDataBrowsingPlus.DbComChannel dbObject;

/// Flow

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

See also

GetDbComChannel
DbDiagService
DbDiagTroubleCode
DbEnvDataDesc
DbFaultMemory
DbParameter
DbRequest
DbResponse
DbSpecialDataGroup
DbSubComponent
DbTable

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