Difference between revisions of "Extensions.DiagCom.GetParameterAsList"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
[[Category:DiagCom]]
+
{{DISPLAYTITLE:OTX '''GetParameterAsList'''}}[[Category:DiagCom]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | GetParameterAsList | List of parameters within a parameter | [[Term]] | [[DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | [[TypeMismatchException]] | - }}
+
{{ClassificationActivity | GetParameterAsList | List of parameters within a parameter | [[Term]] | [[Extensions.DiagCom|OTX DiagCom extension]] | [[Parameter related terms]] | [[TypeMismatchException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 11: Line 11:
 
The '''GetParameterAsList''' term is a list of parameters within a parameter back. The prerequisite is that the parameter consists of a set of individual parameters of the same type, such as in an array.
 
The '''GetParameterAsList''' term is a list of parameters within a parameter back. The prerequisite is that the parameter consists of a set of individual parameters of the same type, such as in an array.
  
{{TermReturnValue| [[List]] | List of parameter (Type [[Parameter]])}}
+
{{TermReturnValue| [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]] | List of parameter (Type [[Extensions.DiagCom.Parameter|Parameter]])}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ParameterContainer | [[ParameterContainer]] | [[Term]] | - | [1] | The container of the parameter.}}
+
{{TableRowPropertie1| ParameterContainer | [[Extensions.DiagCom.ParameterContainer|ParameterContainer]] | [[Term]] | - | [1] | The container of the parameter.}}
 
|}
 
|}
  
Line 31: Line 31:
  
 
== See also ==
 
== See also ==
[[GetParameterName]] <br/>
+
[[Extensions.DiagCom.GetParameterName|GetParameterName]] <br/>
[[GetParameterSemantic]] <br/>
+
[[Extensions.DiagCom.GetParameterSemantic|GetParameterSemantic]] <br/>
[[GetParameterByPath]]
+
[[Extensions.DiagCom.GetParameterByPath|GetParameterByPath]]

Revision as of 02:54, 15 February 2016

Classification

Name GetParameterAsList
Short Description List of parameters within a parameter
Class Term
Extension OTX DiagCom extension
Group Parameter related terms
Exceptions TypeMismatchException
Checker Rules -
Standard Compliant Yes

OTL Syntax

ListTerm = DiagCom.GetParameterAsList(ParameterContainer);

Description

The GetParameterAsList term is a list of parameters within a parameter back. The prerequisite is that the parameter consists of a set of individual parameters of the same type, such as in an array.

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 List of parameter (Type Parameter)

Properties

Name Data Type Class Default Cardinality Description
ParameterContainer ParameterContainer Term - [1] The container of the parameter.

OTL Examples

DiagCom.Request Request1;
List<DiagCom.Parameter> List1;
DiagCom.ComChannel ComChannel1;

ComChannel1 = DiagCom.GetComChannel("LL_ActuaForStrucBorneSoundUDS", null, false);
Request1 = DiagCom.GetRequest(DiagCom.CreateDiagServiceByName(ComChannel1, "DiagnServi_ReadDataByIdentActuaTestStatu"));
List1 = DiagCom.GetParameterAsList(Request1);

See also

GetParameterName
GetParameterSemantic
GetParameterByPath