Difference between revisions of "Extensions.DiagCom.GetParameterValueAsString"
Jump to navigation
Jump to search
m (Hb moved page GetParameterValueAsString to Extensions.DiagCom.GetParameterValueAsString: #3153) |
|||
| 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 | The actual value of the parameter as a [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | [[TypeMismatchException]] | - }} |
== OTL Syntax == | == OTL Syntax == | ||
| Line 9: | Line 9: | ||
== 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 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 as a [[Core.DataTypes.SimpleDataType.String|String]].)}} |
== 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 33: | Line 33: | ||
== See also == | == See also == | ||
| − | [[GetParameterValueAsBoolean]] <br/> | + | [[Extensions.DiagCom.GetParameterValueAsBoolean|GetParameterValueAsBoolean]] <br/> |
| − | [[GetParameterValueAsInteger]] <br/> | + | [[Extensions.DiagCom.GetParameterValueAsInteger|GetParameterValueAsInteger]] <br/> |
| − | [[GetParameterValueAsFloat]] <br/> | + | [[Extensions.DiagCom.GetParameterValueAsFloat|GetParameterValueAsFloat]] <br/> |
| − | [[GetParameterValueAsByteField]] <br/> | + | [[Extensions.DiagCom.GetParameterValueAsByteField|GetParameterValueAsByteField]] <br/> |
| − | [[GetParameterValueAsQuantity]] | + | [[Extensions.DiagCom.GetParameterValueAsQuantity|GetParameterValueAsQuantity]] |
Revision as of 02:59, 15 February 2016
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
