Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbDiagServiceDbPreConditionStatesBySemantic"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbDiagServiceDbPreConditionStatesBySemantic'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbDiagServiceDbPr...")
 
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbDiagServiceDbPreConditionStatesBySemantic'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbDiagServiceDbPreConditionStatesBySemantic'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbDiagServiceDbPreConditionStatesBySemantic | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbDiagServiceDbPreConditionStatesBySemantic | Gets  the pre condition states of the [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|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);
+
ListTerm DiagDataBrowsingPlus.GetDbDiagServiceDbPreConditionStatesBySemantic(DbDiagServiceTerm dbDiagService, StringTerm semantic);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
+
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbDiagServiceDbPreConditionStatesBySemantic''' returns a [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] of [[Core.DataTypes.SimpleDataType.String|String]] of ECU state (MCDDbEcuState) short names of the given semantic one of which is required to be able to execute the given [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] successfully. The result is reduced to states that have a semantic value equals to the given semantic. An empty list will be delivered if no ECU state of the given semantic is associated with the current [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] as a pre-condition.
−
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 MCDDbDiagComPrimitive::getDbPreConditionStatesBySemantic}}
−
{{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.ComplexDataType.ContainerDataType.List|List]] | Returns a list of [[Core.DataTypes.SimpleDataType.String|String]] of ECU state (MCDDbEcuState) short names of the given semantic one of which is required to be able to execute the given [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] successfully.}}
  
 
== Properties ==
 
== Properties ==
−
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie1| DbDiagService | [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] | [[Term]] | - | [1..1] | The element addresses the '''DbDiagService''' whose pre condition states shall be returned.}}
 +
{{TableRowPropertie2| Semantic | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1..1] | The element addresses the semantic of an ECU state one of which is required to be able to execute an instance of the current [[Extensions.DiagCom.DiagService|DiagService]]. The semantic of a ECU state is given by the semantic definition of the MCDDbEcuStateChart object.}}
 
|}
 
|}
−
-->
 
  
 
== 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.ComChannel ComChannel;
 +
DiagCom.DiagService DiagService;
 +
DiagDataBrowsingPlus.DbDiagService DbDiagService;
 +
List<String> List_String;
  
−
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);
 +
List_String = DiagDataBrowsingPlus.GetDbDiagServiceDbPreConditionStatesBySemantic(DbDiagService, "CURRENTDATA");
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== See also ==
 
== See also ==
−
UPDATING...
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDiagServiceDbDiagService|GetDiagServiceDbDiagService]]<br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetComChannelDbComChannel|GetComChannelDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannel|GetDbComChannel]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetDbComChannelDbDiagServices|GetDbComChannelDbDiagServices]]

Latest revision as of 09:14, 2 November 2018

Classification

Name GetDbDiagServiceDbPreConditionStatesBySemantic
Short Description Gets the pre condition states of the DbDiagService
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbDiagService related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

ListTerm DiagDataBrowsingPlus.GetDbDiagServiceDbPreConditionStatesBySemantic(DbDiagServiceTerm dbDiagService, StringTerm semantic);


Description

GetDbDiagServiceDbPreConditionStatesBySemantic returns a list of String of ECU state (MCDDbEcuState) short names of the given semantic one of which is required to be able to execute the given DbDiagService successfully. The result is reduced to states that have a semantic value equals to the given semantic. An empty list will be delivered if no ECU state of the given semantic is associated with the current DbDiagService as a pre-condition.

Icons Note.png The appropriate MVCI system operation is MCDDbDiagComPrimitive::getDbPreConditionStatesBySemantic

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
List Returns a list of String of ECU state (MCDDbEcuState) short names of the given semantic one of which is required to be able to execute the given DbDiagService successfully.

Properties

Name Data Type Class Default Cardinality Description
DbDiagService DbDiagService Term - [1..1] The element addresses the DbDiagService whose pre condition states shall be returned.
Semantic String Term - [1..1] The element addresses the semantic of an ECU state one of which is required to be able to execute an instance of the current DiagService. The semantic of a ECU state is given by the semantic definition of the MCDDbEcuStateChart object.

OTL Examples

/// Local Declarations

DiagCom.ComChannel ComChannel;
DiagCom.DiagService DiagService;
DiagDataBrowsingPlus.DbDiagService DbDiagService;
List<String> List_String;

/// Flow

ComChannel = DiagCom.GetComChannel("LL_GatewUDS", NULL, false);
DiagService = DiagCom.CreateDiagServiceByName(ComChannel, "DiagnServi_ReadDataByIdentActuaTestStatu");
DbDiagService = DiagDataBrowsingPlus.GetDiagServiceDbDiagService(DiagService);
List_String = DiagDataBrowsingPlus.GetDbDiagServiceDbPreConditionStatesBySemantic(DbDiagService, "CURRENTDATA");

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
GetDiagServiceDbDiagService
GetComChannelDbComChannel
GetDbComChannel
GetDbComChannelDbDiagServices

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