Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbDiagServiceAudienceStates"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbDiagServiceAudienceStates'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbDiagServiceAudienceStates | UPD...")
 
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbDiagServiceAudienceStates'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbDiagServiceAudienceStates'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbDiagServiceAudienceStates | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbDiagServiceAudienceStates | Gets all audience attribute names 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.GetDbDiagServiceAudienceStates(DbDiagServiceTerm dbDiagService);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbDiagServiceAudienceStates''' returns a [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] of [[Core.DataTypes.SimpleDataType.String|strings]] of all audience attribute names, whose are set to true for this [[Extensions.DiagCom.DiagService|DiagService]] in ODX. Valid names are "isAfterMarket", "isAfterSales", "isDevelopment", "isManufacturing", "isSupplier".
−
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 MCDDbDataPrimitive::getAudienceState}}
−
{{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|strings]] of all audience attribute names}}
  
 
== Properties ==
 
== Properties ==
−
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| DbDiagService | [[Extensions.DiagDataBrowsingPlus.DbDiagService|DbDiagService]] | [[Term]] | - | [1..1] | The element addresses the '''DbDiagService''' whose audience states 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.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.GetDbDiagServiceAudienceStates(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.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 GetDbDiagServiceAudienceStates
Short Description Gets all audience attribute names of the DbDiagService
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbDiagService related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

ListTerm DiagDataBrowsingPlus.GetDbDiagServiceAudienceStates(DbDiagServiceTerm dbDiagService);

Description

GetDbDiagServiceAudienceStates returns a list of strings of all audience attribute names, whose are set to true for this DiagService in ODX. Valid names are "isAfterMarket", "isAfterSales", "isDevelopment", "isManufacturing", "isSupplier".

Icons Note.png The appropriate MVCI system operation is MCDDbDataPrimitive::getAudienceState

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 strings of all audience attribute names

Properties

Name Data Type Class Default Cardinality Description
DbDiagService DbDiagService Term - [1..1] The element addresses the DbDiagService whose audience states shall be returned.

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.GetDbDiagServiceAudienceStates(DbDiagService);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
GetDiagServiceDbDiagService
GetComChannelDbComChannel
GetDbComChannel
GetDbComChannelDbDiagServices

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