Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbParameterLengthKey"
Jump to navigation
Jump to search
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:OTX '''GetDbParameterLengthKey'''}}[[Category:DiagDataBrowsingPlus]] | {{DISPLAYTITLE:OTX '''GetDbParameterLengthKey'''}}[[Category:DiagDataBrowsingPlus]] | ||
== Classification == | == Classification == | ||
| − | {{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]] | - }} | + | {{ClassificationActivity | GetDbParameterLengthKey| Gets the corresponding length key parameter 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 == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | DbParameterTerm | + | DbParameterTerm DiagDataBrowsingPlus.GetDbParameterLengthKey(DbParameterTerm dbParameter); |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 13: | Line 13: | ||
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. | 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. | ||
| − | {{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]].}} | {{TermReturnValue| [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] | Returns the corresponding length key parameter of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]].}} | ||
| Line 20: | Line 20: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie2| | + | {{TableRowPropertie2| DbParameter | [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] | [[Term]] | - | [1..1] |The element addresses the '''DbParameter''' (MCDDbParameter) which corresponding length key parameter shall be returned.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| + | /// Local Declarations | ||
| + | |||
DiagCom.Request Request; | DiagCom.Request Request; | ||
DiagCom.Parameter Parameter; | DiagCom.Parameter Parameter; | ||
| Line 40: | Line 42: | ||
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/> | [[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/> | ||
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <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.GetRequest|GetRequest]] <br/> | ||
[[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]] <br/> | [[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]] <br/> | ||
[[Extensions.DiagDataBrowsingPlus.GetParameterDbParameter|GetParameterDbParameter]] | [[Extensions.DiagDataBrowsingPlus.GetParameterDbParameter|GetParameterDbParameter]] | ||
Latest revision as of 08:57, 2 November 2018
Contents
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 dbParameter);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.
The appropriate MVCI system operation is MCDDbParameter::getLengthKey
Return Value
The Term returns the value, see table below.
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
/// Local Declarations
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
CreateDiagServiceBySemantic
ExecuteDiagService
GetFirstResponse
GetRequest
GetParameterByPath
GetParameterDbParameter
