Difference between revisions of "Extensions.DiagCom.GetDefaultComplexComParameter"

From emotive
Jump to navigation Jump to search
 
Line 9: Line 9:
  
 
== Description ==
 
== Description ==
The '''GetDefaultComplexComParameter''' term comprises the '''ChannelAndParameterName''' attribute group and will return the default value of a complex communication parameter (e.g. list and struct parameter types).
+
The '''GetDefaultComplexComParameter''' term will return the default value of a complex communication parameter (e.g. list and struct parameter types).
  
 
{{TermReturnValue| [[Extensions.DiagCom.Parameter|Parameter]] | The default value of a complex communication parameter.}}
 
{{TermReturnValue| [[Extensions.DiagCom.Parameter|Parameter]] | The default value of a complex communication parameter.}}

Latest revision as of 11:51, 24 December 2019

Classification

Name GetDefaultComplexComParameter
Short Description Gets the default value of a complex communication parameter
Class Term
Extension OTX DiagCom extension
Group ComParam related terms
Exceptions UnknownTargetException
TypeMismatchException
Checker Rules -
Standard Compliant Yes

OTL Syntax

ParameterTerm DiagCom.GetDefaultComplexComParameter(ComChannelTerm comChannel, StringTerm comParameterName);

Description

The GetDefaultComplexComParameter term will return the default value of a complex communication parameter (e.g. list and struct parameter types).

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 default 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);
Parameter1 = DiagCom.GetDefaultComplexComParameter(ComChannel1, "CP_TesterPresentMessage");

See also

GetComChannel
GetComplexComParameter