Difference between revisions of "Extensions.DiagCom.GetParameterValueAsString"
Jump to navigation
Jump to search
| (4 intermediate revisions by one other user not shown) | |||
| Line 5: | Line 5: | ||
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | StringTerm | + | StringTerm DiagCom.GetParameterValueAsString(ParameterTerm parameter); |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 11: | Line 11: | ||
The '''GetParameterValueAsString''' term accepts a '''ParameterTerm''' and returns the actual value of the [[Extensions.DiagCom.Parameter|Parameter]] as a [[Core.DataTypes.SimpleDataType.String|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| [[Core.DataTypes.SimpleDataType.String|String]] | The actual value of the '''parameter'''. | + | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | The actual value of the '''parameter'''.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie2| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | The '''Parameter''' whose value | + | {{TableRowPropertie2| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | The '''Parameter''' whose value will be returned as a [[Core.DataTypes.SimpleDataType.String|string]].}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| + | /// Local Declarations | ||
| + | |||
DiagCom.Request Request1; | DiagCom.Request Request1; | ||
DiagCom.Parameter Parameter1; | DiagCom.Parameter Parameter1; | ||
Latest revision as of 10:18, 12 September 2019
Contents
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.
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
