Difference between revisions of "Extensions.DiagCom.GetParameterValueAsString"

From emotive
Jump to navigation Jump to search
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
[[Category:DiagCom]]
+
{{DISPLAYTITLE:OTX '''GetParameterValueAsString'''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetParameterValueAsString | The actual value of the parameter as a [[String]] | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | [[TypeMismatchException]] | - }}
+
{{ClassificationActivity | GetParameterValueAsString | Gets the actual value of the parameter as a [[Core.DataTypes.SimpleDataType.String|String]] | [[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;">
−
GetParameterValueAsString(Parameter parameter, String value);
+
StringTerm DiagCom.GetParameterValueAsString(ParameterTerm parameter);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The '''GetParameterValueAsString''' term accepts a [[ParameterTerm]] and returns the actual value of the parameter as a [[String]].  
+
The '''GetParameterValueAsString''' term accepts a '''ParameterTerm''' and returns the actual value of the [[Extensions.DiagCom.Parameter|Parameter]] as a [[Core.DataTypes.SimpleDataType.String|String]].  
  
−
{{TermReturnValue| [[String]] | The actual value of the parameter as a [[String]].)}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | 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 a [[Core.DataTypes.SimpleDataType.String|string]].}}
 
|}
 
|}
  
−
== Examples ==
+
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
String value = GetParameterValueAsString(parameter);
+
/// Local Declarations
 +
 
 +
DiagCom.Request Request1;
 +
DiagCom.Parameter Parameter1;
 +
DiagCom.ComChannel ComChannel1;
 +
String String1 = "";
 +
 
 +
/// Flow
 +
 +
ComChannel1 = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", NULL, false);
 +
Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentASAMODXFileIdent"));
 +
Parameter1 = DiagCom.GetParameterByPath(Request1, {"Param_RecorDataIdent"});
 +
String1 = DiagCom.GetParameterValueAsString(Parameter1);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
−
[[GetParameterValueAsBoolean]] <br/>
+
[[Extensions.DiagCom.GetComChannel|GetComChannel]] <br/>
−
[[GetParameterValueAsInteger]] <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.GetParameterValueAsInteger|GetParameterValueAsInteger]] <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 GetParameterValueAsString
Short Description Gets the actual value of the parameter as a String
Class Term
Extension OTX DiagCom extension
Group Parameter related terms
Exceptions TypeMismatchException
Checker Rules -
Standard Compliant Yes

OTL Syntax

StringTerm DiagCom.GetParameterValueAsString(ParameterTerm parameter);

Description

The GetParameterValueAsString term accepts a ParameterTerm and returns the actual value of the Parameter as a String.

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
String 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 a string.

OTL Examples

/// Local Declarations

DiagCom.Request Request1;
DiagCom.Parameter Parameter1;
DiagCom.ComChannel ComChannel1;
String String1 = "";

/// Flow
		
ComChannel1 = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", NULL, false);
Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentASAMODXFileIdent"));
Parameter1 = DiagCom.GetParameterByPath(Request1, {"Param_RecorDataIdent"});
String1 = DiagCom.GetParameterValueAsString(Parameter1);

See also

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

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