Difference between revisions of "Extensions.DiagCom.GetDefaultComParameterValueAsBoolean"
Jump to navigation
Jump to search
| Line 9: | Line 9: | ||
== Description == | == Description == | ||
| − | The '''GetDefaultComParameterValueAsBoolean''' term comprises the '''ChannelAndParameterName''' attribute group and | + | The '''GetDefaultComParameterValueAsBoolean''' term comprises the '''ChannelAndParameterName''' attribute group and will return the default value of a [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] type communication parameter. |
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | The default value of a [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] communication parameter.}} | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | The default value of a [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] communication parameter.}} | ||
| Line 16: | Line 16: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | The '''ComChannelTerm''' specifies the '''ComChannel''' which | + | {{TableRowPropertie1| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | The '''ComChannelTerm''' specifies the '''ComChannel''' which will be queried.}} |
{{TableRowPropertie2| ComParameterName | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The '''otx:StringTerm''' specifies the name of a communication parameter.}} | {{TableRowPropertie2| ComParameterName | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The '''otx:StringTerm''' specifies the name of a communication parameter.}} | ||
|} | |} | ||
Revision as of 10:24, 12 September 2019
Contents
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 comprises the ChannelAndParameterName attribute group and will return the default value of a Boolean type communication parameter.
Return Value
The Term returns the value, see table below.
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
