Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbParameters"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbParameters'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbParameters | UPDATING... | Term | Extens...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbParameters'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbParameters'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetDbParameters | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbParameters| Gets the child parameters of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|DbParameter 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.GetDbParameters(DbParameterTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== Description ==
 
== Description ==
UPDATING...<!--
+
'''GetDbParameters''' returns a [[Core.DataTypes.ComplexDataType.ContainerDataType.List|list]] of [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameters]] of the next level (child parameters). This list can be empty if there is no next level.
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 MCDDbParameter::getDbParameters}}
{{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 [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameters]] of the next level (child parameters).}}
  
 
== Properties ==
 
== Properties ==
UPDATING...<!--
 
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Variable]] | - | [1] | Communication Channel (Control unit).}}
+
{{TableRowPropertie2| dbParameter | [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] | [[Term]] | - | [1..1] |The element addresses the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] (MCDDbParameter) which child parameters 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;
+
DiagCom.Parameter Parameter;
 +
DiagDataBrowsingPlus.DbParameter DbParameter;
 +
List<DiagDataBrowsingPlus.DbParameter> List_DbParameter;
  
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
// Code example using the variable myComChannel
+
Parameter = DiagCom.GetParameterByPath(DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "SinglJob_WriteFinge")), {"IPA_ProgrDate"});
// ...
+
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
List_DbParameter = DiagDataBrowsingPlus.GetDbParameters(DbParameter);
 
</syntaxhighlight>
 
</syntaxhighlight>
-->
 
  
 
== See also ==
 
== See also ==
UPDATING...
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
 +
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
 +
[[Extensions.DiagCom.GetFirstResponse|GetFirstResponse]] <br/>
 +
[[Extensions.DiagCom.GetRequest|GetRequest]] <br/>
 +
[[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetParameterDbParameter|GetParameterDbParameter]]

Revision as of 10:49, 13 September 2018

Classification

Name GetDbParameters
Short Description Gets the child parameters of the DbParameter
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbParameter related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

ListTerm = DiagDataBrowsingPlus.GetDbParameters(DbParameterTerm);

Description

GetDbParameters returns a list of DbParameters of the next level (child parameters). This list can be empty if there is no next level.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbParameter::getDbParameters

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 DbParameters of the next level (child parameters).

Properties

Name Data Type Class Default Cardinality Description
dbParameter DbParameter Term - [1..1] The element addresses the DbParameter (MCDDbParameter) which child parameters shall be returned.

OTL Examples

DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;
List<DiagDataBrowsingPlus.DbParameter> List_DbParameter;

/// Flow

Parameter = DiagCom.GetParameterByPath(DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "SinglJob_WriteFinge")), {"IPA_ProgrDate"});
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
List_DbParameter = DiagDataBrowsingPlus.GetDbParameters(DbParameter);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterDbParameter