Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbParameterMaxNumberOfItems"

From emotive
Jump to navigation Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''GetDbParameterMaxNumberOfItems'''}}Category:DiagDataBrowsingPlus == Classification == {{ClassificationActivity | GetDbParameterMaxNumberOfItems | UPD...")
 
Line 1: Line 1:
 
{{DISPLAYTITLE:OTX '''GetDbParameterMaxNumberOfItems'''}}[[Category:DiagDataBrowsingPlus]]
 
{{DISPLAYTITLE:OTX '''GetDbParameterMaxNumberOfItems'''}}[[Category:DiagDataBrowsingPlus]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetDbParameterMaxNumberOfItems | UPDATING... | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | UPDATING... | UPDATING... | UPDATING... }}
+
{{ClassificationActivity | GetDbParameterMaxNumberOfItems| Gets the maximum number of items 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);
+
IntegerTerm= DiagDataBrowsingPlus.GetDbParameterMaxNumberOfItems(DbParameterTerm);
 
</syntaxhighlight>
 
</syntaxhighlight>
−
-->
 
  
 
== Description ==
 
== Description ==
−
UPDATING...<!--
+
'''GetDbParameterMaxNumberOfItems''' returns 1 in case of a simple parameter type or eSTRUCTURE or the maximum number of items of a parameter of type eEND_OF_PDU.
−
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 MCDDbRequestParameter::getMaxNumberOfItems}}
−
{{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.SimpleDataType.Integer|Integer]] | Returns 1 in case of a simple parameter type or eSTRUCTURE or the maximum number of items of a parameter of type eEND_OF_PDU.}}
  
 
== 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]] (MCDDbRequestParameter) which maximum number of items 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;
 +
Integer MyInteger;
  
−
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);
 +
MyInteger = DiagDataBrowsingPlus.GetDbParameterMaxNumberOfItems(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:50, 13 September 2018

Classification

Name GetDbParameterMaxNumberOfItems
Short Description Gets the maximum number of items of the DbParameter
Class Term
Extension OTX DiagDataBrowsingPlus extension
Group DbParameter related terms
Exceptions NONE
Checker Rules -
Standard Compliant Yes

OTL Syntax

IntegerTerm= DiagDataBrowsingPlus.GetDbParameterMaxNumberOfItems(DbParameterTerm);

Description

GetDbParameterMaxNumberOfItems returns 1 in case of a simple parameter type or eSTRUCTURE or the maximum number of items of a parameter of type eEND_OF_PDU.

Icons Note.png NOTE — The appropriate MVCI system operation is MCDDbRequestParameter::getMaxNumberOfItems

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
Integer Returns 1 in case of a simple parameter type or eSTRUCTURE or the maximum number of items of a parameter of type eEND_OF_PDU.

Properties

Name Data Type Class Default Cardinality Description
dbParameter DbParameter Term - [1..1] The element addresses the DbParameter (MCDDbRequestParameter) which maximum number of items shall be returned.

OTL Examples

DiagCom.Request Request;
DiagCom.Parameter Parameter;
DiagDataBrowsingPlus.DbParameter DbParameter;
Integer MyInteger;

/// Flow

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

See also

GetComChannel
CreateDiagServiceByName
GetRequest
GetParameterByPath
GetParameterDbParameter

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