Difference between revisions of "Extensions.DiagDataBrowsingPlus.GetDbParameterTable"
Jump to navigation
Jump to search
| (4 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| Gets the table parameter of the related structure of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]] | [[Term]] | [[Extensions.DiagDataBrowsingPlus|OTX DiagDataBrowsingPlus extension]] | [[Extensions.DiagDataBrowsingPlus|DbParameter related terms]] | [[Extensions.DiagDataBrowsingPlus.InvalidTypeException|InvalidTypeException]] | - }} | + | {{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 == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | DbTableTerm | + | DbTableTerm DiagDataBrowsingPlus.GetDbParameterTable(DbParameterTerm dbParameter); |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 13: | Line 13: | ||
If the [[Extensions.DiagCom.Parameter|parameter]] is not of parameter type eTABLE_STRUCT, the [[Extensions.DiagDataBrowsingPlus.InvalidTypeException|InvalidTypeException]] exception will be thrown. | If the [[Extensions.DiagCom.Parameter|parameter]] is not of parameter type eTABLE_STRUCT, the [[Extensions.DiagDataBrowsingPlus.InvalidTypeException|InvalidTypeException]] exception will be thrown. | ||
| − | {{Note| | + | {{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.}} | {{TermReturnValue| [[Extensions.DiagDataBrowsingPlus.DbTable|DbTable]] | Returns the DbTable Parameter structure of the [[Extensions.DiagDataBrowsingPlus.DbParameter|DbParameter]], if available.}} | ||
| 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 table 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.Result Result; | DiagCom.Result Result; | ||
DiagCom.Response Response; | DiagCom.Response Response; | ||
Latest revision as of 08:54, 2 November 2018
Contents
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.
The appropriate MVCI system operation is MCDDbParameter::getDbTable
Return Value
The Term returns the value, see table below.
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
