Difference between revisions of "Extensions.DataType.EnumerationGetEntryList"

From emotive
Jump to navigation Jump to search
(Edited by Ngoc Tran.)
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
−
{{DISPLAYTITLE:OTX '''EnumerationGetEntryList'''}}[[Category:DataTypes]]
+
{{DISPLAYTITLE:OTX '''EnumerationGetEntryList'''}}[[Category:DataType]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | EnumerationGetEntryList | Returns a List of String of the names in a specified enumeration | [[Term]] | [[Extensions.DataTypes|OTX DataTypes extension]] | [[EnumerationGetEntryList related terms]] | - | - }}
+
{{ClassificationActivity | EnumerationGetEntryList | Returns a List of String of the names in a specified enumeration | [[Term]] | [[Extensions.DataType|OTX DataTypes extension]] | [[Extensions.DataType#Term|EnumerationGetEntryList related terms]] | - | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
DataTypes.EnumerationGetEntryList(EnumerationSignature);
+
/// Local Declarations
 +
List<String> ListVariable;
 +
/// Flow
 +
ListVariable = DataType.EnumerationGetEntryList(OtxLink);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 16: Line 19:
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| Enumeration | [[OtxLink]] | - | - | [1] | This attribute identifies the specified enumeration to get the entry list. The link shall point to the corresponding '''EnumerationSignature'''.}}
+
{{TableRowPropertie2| Enumeration | [[OtxLink]] | - | - | [1] | This attribute identifies the specified enumeration to get the entry list. The link will point to the corresponding '''EnumerationSignature'''.}}
  
 
|}
 
|}
Line 22: Line 25:
 
== OTL Examples ==
 
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
package DataTypes.EnumerationSignature EnumerationSignature1(Integer EnumerationElement1 = 7, Integer EnumerationElement2 = 12);
+
package DataType.EnumerationSignature EnumerationSignature1(Integer EnumerationElement1 = 7, Integer EnumerationElement2 = 12);
 +
 
 +
/// Global Declarations
 +
 
 
public procedure main()
 
public procedure main()
 
{
 
{
−
  List<String> entryList;
+
        /// Local Declarations
 +
 
 +
        List<String> entryList;
 +
 
 +
        /// Flow
  
−
  entryList = DataTypes.EnumerationGetEntryList(EnumerationSignature1);
+
        entryList = DataType.EnumerationGetEntryList(EnumerationSignature1);
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
−
[[Extensions.DataTypes.EnumerationContainsName|EnumerationContainsName]] <br/>
+
[[Extensions.DataType.EnumerationContainsName|EnumerationContainsName]] <br/>
−
[[Extensions.DataTypes.EnumerationContainsValue|EnumerationContainsValue]] <br/>
+
[[Extensions.DataType.EnumerationContainsValue|EnumerationContainsValue]] <br/>
−
<!-- [[Extensions.DataTypes.EnumerationGetEntryList|EnumerationGetEntryList]] <br/> -->
+
<!-- [[Extensions.DataType.EnumerationGetEntryList|EnumerationGetEntryList]] <br/> -->
−
[[Extensions.DataTypes.GetEnumerationByName|GetEnumerationByName]] <br/>
+
[[Extensions.DataType.GetEnumerationByName|GetEnumerationByName]] <br/>
−
[[Extensions.DataTypes.GetEnumerationByValue|GetEnumerationByValue]] <br/>
+
[[Extensions.DataType.GetEnumerationByValue|GetEnumerationByValue]] <br/>
−
[[Extensions.DataTypes.StructureCopy|StructureCopy]] <br/>
+
[[Extensions.DataType.StructureCopy|StructureCopy]] <br/>

Latest revision as of 04:56, 11 November 2019

Classification

Name EnumerationGetEntryList
Short Description Returns a List of String of the names in a specified enumeration
Class Term
Extension OTX DataTypes extension
Group EnumerationGetEntryList related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

/// Local Declarations
List<String> ListVariable;
/// Flow
ListVariable = DataType.EnumerationGetEntryList(OtxLink);

Description

EnumerationGetEntryList is a term that returns a List of String of the names in a specified enumeration.

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 Returns a List of String of the names in a specified enumeration.

Properties

Name Data Type Class Default Cardinality Description
Enumeration OtxLink - - [1] This attribute identifies the specified enumeration to get the entry list. The link will point to the corresponding EnumerationSignature.

OTL Examples

package DataType.EnumerationSignature EnumerationSignature1(Integer EnumerationElement1 = 7, Integer EnumerationElement2 = 12);

/// Global Declarations

public procedure main()
{
        /// Local Declarations

        List<String> entryList;

        /// Flow

        entryList = DataType.EnumerationGetEntryList(EnumerationSignature1);
}

See also

EnumerationContainsName
EnumerationContainsValue
GetEnumerationByName
GetEnumerationByValue
StructureCopy

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.DataType.EnumerationGetEntryList&oldid=10072"