Extensions.DiagCom.GetDefaultComParameterValueAsBoolean

From emotive
Jump to navigation Jump to search

Classification

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

OTL Syntax

BooleanTerm DiagCom.GetDefaultComParameterValueAsBoolean(ComChannelTerm comChannel, StringTerm comParameterName);

Description

The GetDefaultComParameterValueAsBoolean term will return the default value of a Boolean type communication parameter.

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
Boolean The default value of a Boolean 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;
Exception Handle1;
Boolean Boolean1 = false;

/// Flow

try
{
	ComChannel1 = DiagCom.GetComChannel("LL_CentrElectUDS", "EV_BCMCONTI_009", false);
	Boolean1 = DiagCom.GetDefaultComParameterValueAsBoolean(ComChannel1, "CP_Ar");
}
catch (TypeMismatchException Handle1)
{
}

See also

GetComChannel
GetComplexComParameter
SetComplexComParameter
GetDefaultComParameterValueAsString
GetDefaultComParameterValueAsInteger
GetDefaultComParameterValueAsFloat
GetDefaultComParameterValueAsByteField
GetDefaultComParameterValueAsQuantity