Difference between revisions of "Extensions.DiagCom.GetComplexComParameter"

From emotive
Jump to navigation Jump to search
 
Line 9: Line 9:
  
 
== Description ==
 
== Description ==
The '''GetComplexComParameter''' term comprises the '''ChannelAndParameterName''' attribute group and 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.
+
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.
  
 
{{TermReturnValue| [[Extensions.DiagCom.Parameter|Parameter]] | The current value of a complex communication parameter}}
 
{{TermReturnValue| [[Extensions.DiagCom.Parameter|Parameter]] | The current value of a complex communication parameter}}

Latest revision as of 10:50, 24 December 2019

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.

Icons Note.png 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