Difference between revisions of "Extensions.DiagCom.GetParameterBySemantic"
Jump to navigation
Jump to search
| Line 11: | Line 11: | ||
The '''GetParameterBySemantic''' term is from a container parameters to the corresponding parameter. The parameter is a [[Semantic Attribute]] selected. | The '''GetParameterBySemantic''' term is from a container parameters to the corresponding parameter. The parameter is a [[Semantic Attribute]] selected. | ||
| − | {{TermReturnValue| [[Parameter]] | Parameter object.}} | + | {{TermReturnValue| [[Extensions.DiagCom.Parameter|Parameter]] | Parameter object.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| ParameterContainer | [[ParameterContainer]] | [[Term]] | - | [1] | Container, which is read out from the parameter.}} | + | {{TableRowPropertie1| ParameterContainer | [[Extensions.DiagCom.ParameterContainer|ParameterContainer]] | [[Term]] | - | [1] | Container, which is read out from the parameter.}} |
| − | {{TableRowPropertie2| Semantic | [[String]] | [[Term]] | "" | [1] | Semantic attribute to classify the diagnostic services (eg: "DEFAULT FAULTREAD" or "IDENTIFICATION").}} | + | {{TableRowPropertie2| Semantic | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | "" | [1] | Semantic attribute to classify the diagnostic services (eg: "DEFAULT FAULTREAD" or "IDENTIFICATION").}} |
|} | |} | ||
| Line 32: | Line 32: | ||
== See also == | == See also == | ||
| − | [[GetParameterByPath]] <br/> | + | [[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]] <br/> |
| − | [[GetParameterName]] <br/> | + | [[Extensions.DiagCom.GetParameterName|GetParameterName]] <br/> |
| − | [[GetParameterSemantic]] <br/> | + | [[Extensions.DiagCom.GetParameterSemantic|GetParameterSemantic]] <br/> |
[[Extensions.DiagCom.GetParameterTextId|GetParameterTextId]] <br/> | [[Extensions.DiagCom.GetParameterTextId|GetParameterTextId]] <br/> | ||
| − | [[GetParameterAsList]] <br/> | + | [[Extensions.DiagCom.GetParameterAsList|GetParameterAsList]] <br/> |
| − | [[ExecuteDiagService]] | + | [[Extensions.DiagCom.ExecuteDiagService|ExecuteDiagService]] |
Revision as of 02:31, 15 February 2016
Contents
Classification
| Name | GetParameterBySemantic |
| Short Description | Returns a parameter whose semantic attribute |
| Class | Term |
| Extension | OTX DiagCom extension |
| Group | Parameter related terms |
| Exceptions | AmbiguousSemanticException |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
ParameterTerm = DiagCom.GetParameterBySemantic(ParameterContainer, StringTerm);Description
The GetParameterBySemantic term is from a container parameters to the corresponding parameter. The parameter is a Semantic Attribute selected.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| Parameter | Parameter object. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| ParameterContainer | ParameterContainer | Term | - | [1] | Container, which is read out from the parameter. |
| Semantic | String | Term | "" | [1] | Semantic attribute to classify the diagnostic services (eg: "DEFAULT FAULTREAD" or "IDENTIFICATION"). |
OTL Examples
DiagCom.Parameter Parameter1;
DiagCom.DiagService DiagService1;
DiagCom.ComChannel ComChannel1;
ComChannel1 = DiagCom.GetComChannel("LL_AirbaUDS", null, false);
DiagService1 = DiagCom.CreateDiagServiceBySemantic(ComChannel1, "DEFAULT-FAULT-READ");
Parameter1 = DiagCom.GetParameterBySemantic(DiagCom.GetRequest(DiagService1), "SERVICE-ID");See also
GetParameterByPath
GetParameterName
GetParameterSemantic
GetParameterTextId
GetParameterAsList
ExecuteDiagService
