Difference between revisions of "Extensions.DiagCom.GetComplexComParameter"
Jump to navigation
Jump to search
m (Nb moved page GetComplexParameter to GetComplexComParameter) |
|||
| (9 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[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.GetComplexComParameter(ComChannelTerm comChannel, StringTerm comParameterName); | |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The ''' | + | The '''GetComplexComParameter''' term will 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 will be returned. |
| − | types). | ||
| − | {{TermReturnValue| [[Parameter]] | | + | {{TermReturnValue| [[Extensions.DiagCom.Parameter|Parameter]] | The current value of a complex communication parameter}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| ComChannel | [[ComChannel]] | [[Term]] | - | [1] | | + | {{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | The '''ComChannelTerm''' specifies the '''ComChannel''' which will be queried.}} |
| − | {{TableRowPropertie2| ComParameterName | [[String]] | [[Term]] | - | [1] | | + | {{TableRowPropertie2| ComParameterName | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The '''otx:StringTerm''' specifies the name of a communication parameter.}} |
|} | |} | ||
| − | == Examples == | + | == OTL Examples == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | Parameter | + | /// Local Declarations |
| + | |||
| + | 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"); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== See also == | == See also == | ||
| − | [[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/> | ||
Latest revision as of 09:50, 24 December 2019
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 comChannel, StringTerm comParameterName);Description
The GetComplexComParameter term will 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 will 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 will be queried. |
| ComParameterName | String | Term | - | [1] | The otx:StringTerm specifies the name of a communication parameter. |
OTL Examples
/// Local Declarations
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
