Difference between revisions of "Extensions.DiagCom.GetParameterValueAsInteger"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
[[Category:DiagCom]]
+
{{DISPLAYTITLE:OTX '''GetParameterValueAsInteger'''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetParameterValueAsInteger | The actual value of the parameter as a [[Integer]] | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | [[TypeMismatchException]] | - }}
+
{{ClassificationActivity | GetParameterValueAsInteger | The actual value of the parameter as a [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | [[TypeMismatchException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 9: Line 9:
  
 
== Description ==
 
== Description ==
The '''GetParameterValueAsInteger''' term accepts a [[ParameterTerm]] and returns the actual value of the parameter as a [[Integer]].
+
The '''GetParameterValueAsInteger''' term accepts a [[ParameterTerm]] and returns the actual value of the parameter as a [[Core.DataTypes.SimpleDataType.Integer|Integer]].
  
{{TermReturnValue| [[Interger]] | The actual value of the parameter as a [[Interger]].)}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Integer|Interger]] | The actual value of the parameter as a [[Core.DataTypes.SimpleDataType.Integer|Interger]].)}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| Parameter | [[Parameter]] | [[Term]] | - | [1] | The parameter object.}}
+
{{TableRowPropertie1| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | The parameter object.}}
 
|}
 
|}
  
Line 35: Line 35:
  
 
== See also ==
 
== See also ==
[[GetParameterValueAsBoolean]] <br/>
+
[[Extensions.DiagCom.GetParameterValueAsBoolean|GetParameterValueAsBoolean]] <br/>
[[GetParameterValueAsString]] <br/>
+
[[Extensions.DiagCom.GetParameterValueAsString|GetParameterValueAsString]] <br/>
[[GetParameterValueAsFloat]] <br/>
+
[[Extensions.DiagCom.GetParameterValueAsFloat|GetParameterValueAsFloat]] <br/>
[[GetParameterValueAsByteField]] <br/>
+
[[Extensions.DiagCom.GetParameterValueAsByteField|GetParameterValueAsByteField]] <br/>
[[GetParameterValueAsQuantity]]
+
[[Extensions.DiagCom.GetParameterValueAsQuantity|GetParameterValueAsQuantity]]

Revision as of 03:01, 15 February 2016

Classification

Name GetParameterValueAsInteger
Short Description The actual value of the parameter as a Integer
Class Term
Extension OTX DiagCom extension
Group Parameter related terms
Exceptions TypeMismatchException
Checker Rules -
Standard Compliant Yes

OTL Syntax

IntegerTerm = DiagCom.GetParameterValueAsInteger(ParameterTerm);

Description

The GetParameterValueAsInteger term accepts a ParameterTerm and returns the actual value of the parameter as a Integer.

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
Interger The actual value of the parameter as a Interger.)

Properties

Name Data Type Class Default Cardinality Description
Parameter Parameter Term - [1] The parameter object.

OTL Examples

DiagCom.DiagService DiagService1;
DiagCom.Request Request1;
DiagCom.Parameter Parameter1;
Integer ValueAsInteger;
DiagCom.Comchannel ComChannel1;

ComChannel1 = DiagCom.GetComChannel("LL_BatteMonitContrModulUDS", "", false);
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentASAMODXFileIdent");
Request1 = DiagCom.GetRequest(DiagService1);
Parameter1 = DiagCom.GetParameterByPath(Request1, {"Param_RequeServiId"});
ValueAsInteger = DiagCom.GetParameterValueAsInteger(Parameter1);

See also

GetParameterValueAsBoolean
GetParameterValueAsString
GetParameterValueAsFloat
GetParameterValueAsByteField
GetParameterValueAsQuantity