Difference between revisions of "Extensions.DiagDataBrowsingPlus.IsDbDiagServiceJob"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''IsDbDiagServiceJob'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''IsDbDiagServiceJob'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | IsDbDiagServiceJob | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | IsDbDiagServiceJob | Checks whether the [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] is a job or not. | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|DbDiagService 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);
+
BooleanTerm = DiagDataBrowsingPlus.IsDbDiagServiceJob(DbDiagServiceTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''IsDbDiagServiceJob''' returns True if the DbDiagService is a job otherwise False. It returns only True if the method getOjectType returns eMCDMULTIPLEECUJOB, eMCDFLASHJOB or eMCDSINGLEECUJOB.
−
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 MCDDbDiagComPrimitive::getObjectType}}
−
{{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.Boolean|Boolean]] | Returns True if the DbDiagService is a job otherwise False.}}
  
 
== Properties ==
 
== Properties ==
−
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie1| diagService | [[Extensions.DiagCom.DiagService|DiagService]] | [[Term]] | - | [1..1] | The element addresses the [[Extensions.DiagCom.DiagService|DiagService]] which is checked whether it is a job or not.}}
 
|}
 
|}
−
-->
 
  
 
== 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;
+
DiagCom.ComChannel ComChannel;
 +
DiagCom.DiagService DiagService;
 +
DiagDataBrowsingPlus.DbDiagService DbDiagService;
 +
Boolean MyBoolean = false;
  
−
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
−
// Code example using the variable myComChannel
+
ComChannel = DiagCom.GetComChannel("LL_GatewUDS", NULL, false);
−
// ...
+
DiagService = DiagCom.CreateDiagServiceByName(ComChannel, "DiagnServi_ReadDataByIdentActuaTestStatu");
−
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
DbDiagService = DiagDataBrowsingPlus.GetDiagServiceDbDiagService(DiagService);
 +
MyBoolean = DiagDataBrowsingPlus.IsDbDiagServiceJob(DbDiagService);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== See also ==
 
== See also ==
−
UPDATING...
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetComChannelDbComChannel|GetComChannelDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbDiagServices|GetDbComChannelDbDiagServices]]

Revision as of 09:05, 10 September 2018

Classification

Name IsDbDiagServiceJob
Short Description Checks whether the DbDiagService is a job or not.
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbDiagService related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

BooleanTerm = DiagDataBrowsingPlus.IsDbDiagServiceJob(DbDiagServiceTerm);

Description

IsDbDiagServiceJob returns True if the DbDiagService is a job otherwise False. It returns only True if the method getOjectType returns eMCDMULTIPLEECUJOB, eMCDFLASHJOB or eMCDSINGLEECUJOB.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbDiagComPrimitive::getObjectType

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
Boolean Returns True if the DbDiagService is a job otherwise False.

Properties

Name Data Type Class Default Cardinality Description
diagService DiagService Term - [1..1] The element addresses the DiagService which is checked whether it is a job or not.

OTL Examples

DiagCom.ComChannel ComChannel;
DiagCom.DiagService DiagService;
DiagDataBrowsingPlus.DbDiagService DbDiagService;
Boolean MyBoolean = false;

/// Flow

ComChannel = DiagCom.GetComChannel("LL_GatewUDS", NULL, false);
DiagService = DiagCom.CreateDiagServiceByName(ComChannel, "DiagnServi_ReadDataByIdentActuaTestStatu");
DbDiagService = DiagDataBrowsingPlus.GetDiagServiceDbDiagService(DiagService);
MyBoolean = DiagDataBrowsingPlus.IsDbDiagServiceJob(DbDiagService);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
GetComChannelDbComChannel
GetDbComChannel
GetDbComChannelDbDiagServices

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