Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbParameterLengthKey"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbParameterLengthKey'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbParameterLengthKey | UPDATING... | T...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbParameterLengthKey'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbParameterLengthKey'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbParameterLengthKey | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbParameterLengthKey| Gets the corresponding length key parameter of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|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);
+
DbParameterTerm = DiagDataBrowsingPlus.GetDbParameterLengthKey(DbParameterTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbParameterLengthKey''' returns the corresponding request parameter with type eLENGTHKEY for this parameter with variable length.
−
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 variable length or no lengthkey can be determined, 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|NOTE — The appropriate MVCI system operation is MCDDbParameter::getLengthKey}}
 +
 
 +
{{TermReturnValue| [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] | Returns the corresponding length key parameter of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]].}}
  
 
== 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 corresponding length key 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;
+
DiagCom.Request Request;
 +
DiagCom.Parameter Parameter;
 +
DiagDataBrowsingPlus.DbParameter DbParameter;
  
−
myComCannel = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
  
−
// Code example using the variable myComChannel
+
Request = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", "", false), "DiagnServi_WriteMemorByAddreMCD20001"));
−
// ...
+
Parameter = DiagCom.GetParameterByPath(Request, {"Param_MemorAddre"});
−
DiagCom.CloseComChannel(myComCannel);</syntaxhighlight>
+
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
 +
DbParameter = DiagDataBrowsingPlus.GetDbParameterLengthKey(DbParameter);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== See also ==
 
== See also ==
−
UPDATING...
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
 +
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
 +
[[Extensions.DiagCom.GetRequest|GetRequest]] <br/>
 +
[[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]] <br/>
 +
[[Extensions.DiagDataBrowsingPlus.GetParameterDbParameter|GetParameterDbParameter]]

Revision as of 08:10, 13 September 2018

Classification

Name GetDbParameterLengthKey
Short Description Gets the corresponding length key parameter of the DbParameter
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbParameter related terms
Exceptions InvalidTypeException
Checker Rules -
Standard Compliant Yes

OTL Syntax

DbParameterTerm = DiagDataBrowsingPlus.GetDbParameterLengthKey(DbParameterTerm);

Description

GetDbParameterLengthKey returns the corresponding request parameter with type eLENGTHKEY for this parameter with variable length.

If the parameter is not of variable length or no lengthkey can be determined, the InvalidTypeException exception will be thrown.

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

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
DbParameter Returns the corresponding length key parameter of the DbParameter.

Properties

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

OTL Examples

DiagCom.Request Request;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;

/// Flow

Request = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", "", false), "DiagnServi_WriteMemorByAddreMCD20001"));
Parameter = DiagCom.GetParameterByPath(Request, {"Param_MemorAddre"});
DbParameter = DiagDataBrowsingPlus.GetParameterDbParameter(Parameter);
DbParameter = DiagDataBrowsingPlus.GetDbParameterLengthKey(DbParameter);

See also

GetComChannel
CreateDiagServiceByName
GetRequest
GetParameterByPath
GetParameterDbParameter

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