Difference between revisions of "Extensions.DiagCom.GetComplexComParameter"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:OTX ''' GetComplexParameter'''}}[[Category:DiagCom]] | {{DISPLAYTITLE:OTX ''' GetComplexParameter'''}}[[Category:DiagCom]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetComplexParameter | | + | {{ClassificationActivity | GetComplexParameter | Gets the current value of a complex communication parameter | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Terms|ComParam related terms]] | [[Extensions.DiagCom.UnknownTargetException|UnknownTargetException]] <br/> [[Core.DataTypes.ComplexDataType.TypeMismatchException|TypeMismatchException]] | - }} |
== Pseudo-Code Syntax == | == Pseudo-Code Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | ParameterTerm = DiagCom. | + | ParameterTerm = DiagCom.GetComplexComParameter(ComChannelTerm, StringTerm); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The ''' | + | The '''GetComplexComParameter''' term comprises the '''ChannelAndParameterName''' attribute group and shall return the current value of a complex communication parameter (e.g. list and struct parameter types). If the communication parameter has not been previously modified by the [[Extensions.DiagCom.SetComplexComParameter|SetComplexComParameter]] action, the default parameter value shall be returned. |
| − | types). | ||
| − | {{TermReturnValue| [[Extensions.DiagCom.Parameter|Parameter]] | | + | {{TermReturnValue| [[Extensions.DiagCom.Parameter|Parameter]] | The current value of a complex communication parameter}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | | + | {{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | The '''ComChannelTerm''' specifies the '''ComChannel''' which shall be queried.}} |
| − | {{TableRowPropertie2| ComParameterName | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | | + | {{TableRowPropertie2| ComParameterName | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The '''otx:StringTerm''' specifies the name of a communication parameter.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | DiagCom.ComChannel | + | DiagCom.ComChannel ComChannel1; |
| − | |||
DiagCom.Parameter Parameter1; | DiagCom.Parameter Parameter1; | ||
| − | + | /// Flow | |
| − | + | ||
| − | Parameter1 = DiagCom.GetComplexComParameter( | + | ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false); |
| + | DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, NULL, NULL, false, false); | ||
| + | Parameter1 = DiagCom.GetComplexComParameter(ComChannel1, "CP_TesterPresentMessage"); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[Extensions.DiagCom.GetDefaultComplexComParameter|GetDefaultComplexComParameter]] | + | [[Extensions.DiagCom.GetComChannel|GetComChannel]]<br/> |
| + | [[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]]<br/> | ||
| + | [[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]]<br/> | ||
| + | [[Extensions.DiagCom.SetComplexComParameter|SetComplexComParameter]]<br/> | ||
| + | [[Extensions.DiagCom.GetDefaultComplexComParameter|GetDefaultComplexComParameter]]<br/> | ||
Revision as of 08:32, 15 October 2018
Contents
Classification
| Name | GetComplexParameter |
| Short Description | Gets the current value of a complex communication parameter |
| Class | Term |
| Extension | OTX DiagCom extension |
| Group | ComParam related terms |
| Exceptions | UnknownTargetException TypeMismatchException |
| Checker Rules | - |
| Standard Compliant | Yes |
Pseudo-Code Syntax
ParameterTerm = DiagCom.GetComplexComParameter(ComChannelTerm, StringTerm);Description
The GetComplexComParameter term comprises the ChannelAndParameterName attribute group and shall return the current value of a complex communication parameter (e.g. list and struct parameter types). If the communication parameter has not been previously modified by the SetComplexComParameter action, the default parameter value shall be returned.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| Parameter | The current value of a complex communication parameter |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| ComChannel | ComChannel | Term | - | [1] | The ComChannelTerm specifies the ComChannel which shall be queried. |
| ComParameterName | String | Term | - | [1] | The otx:StringTerm specifies the name of a communication parameter. |
OTL Examples
DiagCom.ComChannel ComChannel1;
DiagCom.Parameter Parameter1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false);
DiagCom.ExecuteDiagService(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"), {}, {}, NULL, NULL, false, false);
Parameter1 = DiagCom.GetComplexComParameter(ComChannel1, "CP_TesterPresentMessage");See also
GetComChannel
CreateDiagServiceByName
ExecuteDiagService
SetComplexComParameter
GetDefaultComplexComParameter
