Difference between revisions of "Extensions.DataType.EnumerationContainsValue"
Jump to navigation
Jump to search
(Edited by Ngoc Tran.) |
|||
| (5 intermediate revisions by one other user not shown) | |||
| Line 5: | Line 5: | ||
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | DataType.EnumerationContainsValue(NumericTerm, | + | /// Local Declarations |
| + | Boolean BooleanVariable = false; | ||
| + | /// Flow | ||
| + | BooleanVariable = DataType.EnumerationContainsValue(NumericTerm, OtxLink); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 17: | Line 20: | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
{{TableRowPropertie1| Value | - | [[Term]] | - | [1] | The numeric value to be checked inside the specified enumeration.}} | {{TableRowPropertie1| Value | - | [[Term]] | - | [1] | The numeric value to be checked inside the specified enumeration.}} | ||
| − | {{TableRowPropertie2| Enumeration | [[OtxLink]] | - | - | [1] | This attribute identifies the specified enumeration to check the value. The link | + | {{TableRowPropertie2| Enumeration | [[OtxLink]] | - | - | [1] | This attribute identifies the specified enumeration to check the value. The link will point to the corresponding '''EnumerationSignature'''.}} |
|} | |} | ||
| Line 24: | Line 27: | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
package DataType.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() | ||
{ | { | ||
| − | + | /// Local Declarations | |
| + | |||
| + | Boolean checkEnumValue; | ||
| + | |||
| + | /// Flow | ||
| − | + | checkEnumValue = DataType.EnumerationContainsValue(12, EnumerationSignature1); | |
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Latest revision as of 02:57, 11 November 2019
Contents
Classification
| Name | EnumerationContainsValue |
| Short Description | Checks if the specified enumeration contains the value |
| Class | Term |
| Extension | OTX DataTypes extension |
| Group | EnumerationContainsValue related terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
/// Local Declarations
Boolean BooleanVariable = false;
/// Flow
BooleanVariable = DataType.EnumerationContainsValue(NumericTerm, OtxLink);Description
EnumerationContainsValue is a term to checks if the specified enumeration contains the value.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| Boolean | This value is TRUE if the specified enumeration contains the value. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Value | - | Term | - | [1] | The numeric value to be checked inside the specified enumeration. |
| Enumeration | OtxLink | - | - | [1] | This attribute identifies the specified enumeration to check the value. 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
Boolean checkEnumValue;
/// Flow
checkEnumValue = DataType.EnumerationContainsValue(12, EnumerationSignature1);
}See also
EnumerationContainsName
EnumerationGetEntryList
GetEnumerationByName
GetEnumerationByValue
StructureCopy
