Difference between revisions of "Extensions.DiagDataBrowsing.GetAllowedParameterValueList"
Jump to navigation
Jump to search
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:DiagDataBrowsing]] | + | {{DISPLAYTITLE:OTX '''GetAllowedParameterValueList'''}}[[Category:DiagDataBrowsing]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | GetAllowedParameterValueList | Return list of all permissible values of a parameter | [[Term]] | [[DiagDataBrowsing|OTX DiagDataBrowsing extension]] | [[DiagDataBrowsing terms]] | - | - }} | + | {{ClassificationActivity | GetAllowedParameterValueList | Return list of all permissible values of a parameter | [[Term]] | [[Extensions.DiagDataBrowsing|OTX DiagDataBrowsing extension]] | [[Extensions.DiagDataBrowsing#Terms|DiagDataBrowsing terms]] | - | - }} |
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | ListTerm | + | ListTerm DiagDataBrowsing.GetAllowedParameterValueList(ParameterTerm Parameter); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | '''GetAllowedParameterValueList''' returns a list of strings containing | + | '''GetAllowedParameterValueList''' returns a list of strings containing the allowed values for a parameter. If there is no enumeration of allowed values associated to the parameter, the empty list will be returned. |
| − | {{TermReturnValue| [[List]] | Return list of all permissible values of a parameter}} | + | {{Note|NOTE — In the case of a MVCI/ODX based system, this applies only to parameters which have a TEXTTABLE as COMPU-METHOD or to parameters which are of type TABLE-KEY. For those parameters the list contains all valid entries of a TEXTTABLE or all entries which are valid for the TABLE-KEY. For other parameters the returned list is empty.}} |
| + | |||
| + | {{TermReturnValue| [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]] | Return list of all permissible values of a parameter}} | ||
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| Parameter | [[Extensions.DiagCom.Parameter|Parameter]] | [[Term]] | - | [1] | The element addresses the name of the request or response parameter.}} |
|} | |} | ||
== OTL Examples == | == OTL Examples == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| + | /// Local Declarations | ||
| + | |||
List<String> List1; | List<String> List1; | ||
DiagCom.ComChannel ComChannel1; | DiagCom.ComChannel ComChannel1; | ||
| Line 27: | Line 31: | ||
DiagCom.Request Request1; | DiagCom.Request Request1; | ||
| − | ComChannel1 = DiagCom.GetComChannel(" | + | /// Flow |
| + | |||
| + | ComChannel1 = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", NULL, false); | ||
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"); | DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"); | ||
List1 = DiagDataBrowsing.GetRequestParameterList(DiagService1); | List1 = DiagDataBrowsing.GetRequestParameterList(DiagService1); | ||
| Line 36: | Line 42: | ||
== See also == | == See also == | ||
| − | [[ | + | [[Extensions.DiagDataBrowsing.GetComChannelList|GetComChannelList]] <br/> |
| − | [[ | + | [[Extensions.DiagDataBrowsing.GetEcuVariantList|GetEcuVariantList]] <br/> |
| − | [[GetDiagServiceList]] <br/> | + | [[Extensions.DiagDataBrowsing.GetDiagServiceList|GetDiagServiceList]] <br/> |
| − | [[GetRequestParameterList]] <br/> | + | [[Extensions.DiagDataBrowsing.GetRequestParameterList|GetRequestParameterList]] <br/> |
| − | [[GetResponseParameterList]] | + | [[Extensions.DiagDataBrowsing.GetResponseParameterList|GetResponseParameterList]] |
Latest revision as of 10:33, 12 September 2019
Contents
Classification
| Name | GetAllowedParameterValueList |
| Short Description | Return list of all permissible values of a parameter |
| Class | Term |
| Extension | OTX DiagDataBrowsing extension |
| Group | DiagDataBrowsing terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
ListTerm DiagDataBrowsing.GetAllowedParameterValueList(ParameterTerm Parameter);Description
GetAllowedParameterValueList returns a list of strings containing the allowed values for a parameter. If there is no enumeration of allowed values associated to the parameter, the empty list will be returned.
NOTE — In the case of a MVCI/ODX based system, this applies only to parameters which have a TEXTTABLE as COMPU-METHOD or to parameters which are of type TABLE-KEY. For those parameters the list contains all valid entries of a TEXTTABLE or all entries which are valid for the TABLE-KEY. For other parameters the returned list is empty.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| List | Return list of all permissible values of a parameter |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Parameter | Parameter | Term | - | [1] | The element addresses the name of the request or response parameter. |
OTL Examples
/// Local Declarations
List<String> List1;
DiagCom.ComChannel ComChannel1;
DiagCom.DiagService DiagService1;
DiagCom.Parameter Parameter1;
DiagCom.Request Request1;
/// Flow
ComChannel1 = DiagCom.GetComChannel("LL_AllEmissRelatUDSSyste", NULL, false);
DiagService1 = DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu");
List1 = DiagDataBrowsing.GetRequestParameterList(DiagService1);
Request1 = DiagCom.GetRequest(DiagService1);
Parameter1 = DiagCom.GetParameterByPath(Request1, {List1[0]});
List1 = DiagDataBrowsing.GetAllowedParameterValueList(Parameter1);See also
GetComChannelList
GetEcuVariantList
GetDiagServiceList
GetRequestParameterList
GetResponseParameterList
