Difference between revisions of "Extensions.DiagCom.GetParameterValueAsInteger"

From emotive
Jump to navigation Jump to search
(Created page with "Category:DiagCom == Classification == {{ClassificationActivity | GetParameterValueAsInteger | The actual value of the parameter as a Integer | Term | DiagCom|OTX...")
 
 
(11 intermediate revisions by 3 users not shown)
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 | Gets the actual value of the parameter as a [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Extensions.DiagCom#Terms|Parameter related terms]] | [[Core.DataTypes.ComplexDataType.TypeMismatchException|TypeMismatchException]] | - }}
  
−
== Pseudo-Code Syntax ==
+
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
GetParameterValueAsInteger(Parameter parameter, Integer value);
+
IntegerTerm DiagCom.GetParameterValueAsInteger(ParameterTerm parameter);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== 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.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| Parameter | [[Parameter]] | [[Term]] | - | [1] | The parameter object.}}
+
{{TableRowPropertie2| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | The '''Parameter''' whose value will be returned as an [[Core.DataTypes.SimpleDataType.Integer|Integer]].}}
 
|}
 
|}
  
−
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
Integer value = GetParameterValueAsInteger(parameter);
+
/// Local Declarations
 +
 
 +
DiagCom.Request Request1;
 +
DiagCom.Parameter Parameter1;
 +
DiagCom.ComChannel ComChannel1;
 +
Integer Integer1;
 +
 
 +
/// Flow
 +
 
 +
ComChannel1 = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", NULL, false);
 +
Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentASAMODXFileIdent"));
 +
Parameter1 = DiagCom.GetParameterByPath(Request1, {"Param_RequeServiId"});
 +
Integer1 = DiagCom.GetParameterValueAsInteger(Parameter1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
−
[[GetParameterValueAsBoolean]] <br/>
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
−
[[GetParameterValueAsString]] <br/>
+
[[Extensions.DiagCom.CreateDiagServiceByName|CreateDiagServiceByName]] <br/>
−
[[GetParameterValueAsFloat]] <br/>
+
[[Extensions.DiagCom.CreateDiagServiceBySemantic|CreateDiagServiceBySemantic]] <br/>
−
[[GetParameterValueAsByteField]] <br/>
+
[[Extensions.DiagCom.GetRequest|GetRequest]] <br/>
−
[[GetParameterValueAsQuantity]]
+
[[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] <br/>
 +
[[Extensions.DiagCom.GetFirstResponse|GetFirstResponse]] <br/>
 +
[[Extensions.DiagCom.GetAllResponses|GetAllResponses]] <br/>
 +
[[Extensions.DiagCom.GetParameterBySemantic|GetParameterBySemantic]] <br/>
 +
[[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]] <br/>
 +
[[Extensions.DiagCom.GetParameterAsList|GetParameterAsList]] <br/>
 +
[[Extensions.DiagCom.GetParameterValueAsBoolean|GetParameterValueAsBoolean]] <br/>
 +
[[Extensions.DiagCom.GetParameterValueAsString|GetParameterValueAsString]] <br/>
 +
[[Extensions.DiagCom.GetParameterValueAsFloat|GetParameterValueAsFloat]] <br/>
 +
[[Extensions.DiagCom.GetParameterValueAsByteField|GetParameterValueAsByteField]] <br/>
 +
[[Extensions.DiagCom.GetParameterValueAsQuantity|GetParameterValueAsQuantity]]

Latest revision as of 10:18, 12 September 2019

Classification

Name GetParameterValueAsInteger
Short Description Gets 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 parameter);

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.

Properties

Name Data Type Class Default Cardinality Description
Parameter Parameter Term - [1] The Parameter whose value will be returned as an Integer.

OTL Examples

/// Local Declarations

DiagCom.Request Request1;
DiagCom.Parameter Parameter1;
DiagCom.ComChannel ComChannel1;
Integer Integer1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", NULL, false);
Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentASAMODXFileIdent"));
Parameter1 = DiagCom.GetParameterByPath(Request1, {"Param_RequeServiId"});
Integer1 = DiagCom.GetParameterValueAsInteger(Parameter1);

See also

GetComChannel
CreateDiagServiceByName
CreateDiagServiceBySemantic
GetRequest
ExecuteDiagService
GetFirstResponse
GetAllResponses
GetParameterBySemantic
GetParameterByPath
GetParameterAsList
GetParameterValueAsBoolean
GetParameterValueAsString
GetParameterValueAsFloat
GetParameterValueAsByteField
GetParameterValueAsQuantity

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.DiagCom.GetParameterValueAsInteger&oldid=9689"