Extensions.DiagDataBrowsing.GetAllowedParameterValueList

From emotive
Jump to navigation Jump to search

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.

Icons Note.png 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.

Icons Note.png 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