Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbParameterTable"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbParameterTable'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbParameterTable | UPDATING... | Term |...")
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbParameterTable'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbParameterTable'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbParameterTable | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbParameterTable| Gets the table parameter of the related structure of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus#Terms|DbParameter related terms]] | [[Extensions.DiagDataBrowsingPlus.InvalidTypeException|InvalidTypeException]] | - }}
  
 
== 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);
+
DbTableTerm DiagDataBrowsingPlus.GetDbParameterTable(DbParameterTerm dbParameter);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbParameterTable''' returns the [[Extensions.DiagDataBrowsingPlus.DbTable|DbTable]] Parameter structure of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]], if available. That is, the decomposition of this parameter into further parameters represents exactly one table row of the table which is returned by this Term. In case of a static reference, the decomposition can already be obtain at this [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] by calling the Term [[Extensions.DiagDataBrowsingPlus.GetDbParameters|GetDbParameters]]. In case of a dynamic reference, the collection returned by the Term [[Extensions.DiagDataBrowsingPlus.GetDbParameters|GetDbParameters]] is empty.
−
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}}
+
If the [[Extensions.DiagCom.Parameter|parameter]] is not of parameter type eTABLE_STRUCT, the [[Extensions.DiagDataBrowsingPlus.InvalidTypeException|InvalidTypeException]] exception will be thrown.
−
{{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!}}
+
 
−
-->
+
{{Note|The appropriate MVCI system operation is MCDDbParameter::getDbTable}}
 +
 
 +
{{TermReturnValue| [[Extensions.DiagDataBrowsingPlus.DbTable|DbTable]] | Returns the DbTable Parameter structure of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]], if available.}}
  
 
== 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 '''DbParameter''' (MCDDbParameter) which table parameter 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.Result Result;
 +
DiagCom.Response Response;
 +
DiagCom.Parameter Parameter;
 +
DiagDataBrowsingPlus.DbParameter DbParameter;
 +
DiagDataBrowsingPlus.DbTable DbTable;
  
−
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
−
// Code example using the variable myComChannel
+
[#MetaData(RequestPdu), <#Data>22 04 3E</#Data>]
−
// ...
+
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDataByIdentCalibData"), {Param_RecorDataIdent = "Theftprotection Showroom Mode"}, {}, Result, NULL, false, false);
−
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
Response = DiagCom.GetFirstResponse(Result);
 +
Parameter = DiagCom.GetParameterByPath(Response, {"Param_DataRecor"});
 +
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
 +
DbTable = DiagDataBrowsingPlus.GetDbParameterTable(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]]

Latest revision as of 08:54, 2 November 2018

Classification

Name GetDbParameterTable
Short Description Gets the table parameter of the related structure of the DbParameter
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbParameter related terms
Exceptions InvalidTypeException
Checker Rules -
Standard Compliant Yes

OTL Syntax

DbTableTerm DiagDataBrowsingPlus.GetDbParameterTable(DbParameterTerm dbParameter);

Description

GetDbParameterTable returns the DbTable Parameter structure of the DbParameter, if available. That is, the decomposition of this parameter into further parameters represents exactly one table row of the table which is returned by this Term. In case of a static reference, the decomposition can already be obtain at this DbParameter by calling the Term GetDbParameters. In case of a dynamic reference, the collection returned by the Term GetDbParameters is empty.

If the parameter is not of parameter type eTABLE_STRUCT, the InvalidTypeException exception will be thrown.

Icons Note.png The appropriate MVCI system operation is MCDDbParameter::getDbTable

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
DbTable Returns the DbTable Parameter structure of the DbParameter, if available.

Properties

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

OTL Examples

/// Local Declarations

DiagCom.Result Result;
DiagCom.Response Response;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;
DiagDataBrowsingPlus.DbTable DbTable;

/// Flow

[#MetaData(RequestPdu), <#Data>22 04 3E</#Data>]
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_GatewUDS", "", false), "DiagnServi_ReadDataByIdentCalibData"), {Param_RecorDataIdent = "Theftprotection Showroom Mode"}, {}, Result, NULL, false, false);
Response = DiagCom.GetFirstResponse(Result);
Parameter = DiagCom.GetParameterByPath(Response, {"Param_DataRecor"});
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
DbTable = DiagDataBrowsingPlus.GetDbParameterTable(DbParameter);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterDbParameter

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