Difference between revisions of "Extensions.DiagCom.GetParameterValueAsString"
Jump to navigation
Jump to search
Line 3: | Line 3: | ||
{{ClassificationActivity | GetParameterValueAsString | The actual value of the parameter as a [[String]] | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | [[TypeMismatchException]] | - }} | {{ClassificationActivity | GetParameterValueAsString | The actual value of the parameter as a [[String]] | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | [[TypeMismatchException]] | - }} | ||
− | == | + | == OTL Syntax == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
− | + | StringTerm = DiagCom.GetParameterValueAsString(ParameterTerm); | |
</syntaxhighlight> | </syntaxhighlight> | ||
Line 19: | Line 19: | ||
|} | |} | ||
− | == Examples == | + | == OTL Examples == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
− | String | + | DiagCom.Request Request1; |
+ | DiagCom.Parameter Parameter1; | ||
+ | String ValueParamAsString; | ||
+ | DiagCom.ComChannel ComChannel1; | ||
+ | |||
+ | ComChannel1 = DiagCom.GetComChannel("LL_BatteEnergContrModulUDS", "", false); | ||
+ | Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentASAMODXFileIdent")); | ||
+ | Parameter1 = DiagCom.GetParameterByPath(Request1, {"Param_RecorDataIdent"}); | ||
+ | ValueParamAsString = DiagCom.GetParameterValueAsString(Parameter1); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 03:24, 6 February 2015
Contents
Classification
Name | GetParameterValueAsString |
Short Description | 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);
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 as a String.) |
Properties
Name | Data Type | Class | Default | Cardinality | Description |
Parameter | Parameter | Term | - | [1] | The parameter object. |
OTL Examples
DiagCom.Request Request1;
DiagCom.Parameter Parameter1;
String ValueParamAsString;
DiagCom.ComChannel ComChannel1;
ComChannel1 = DiagCom.GetComChannel("LL_BatteEnergContrModulUDS", "", false);
Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentASAMODXFileIdent"));
Parameter1 = DiagCom.GetParameterByPath(Request1, {"Param_RecorDataIdent"});
ValueParamAsString = DiagCom.GetParameterValueAsString(Parameter1);
See also
GetParameterValueAsBoolean
GetParameterValueAsInteger
GetParameterValueAsFloat
GetParameterValueAsByteField
GetParameterValueAsQuantity