Difference between revisions of "Extensions.DataType.EnumerationContainsName"
Jump to navigation
Jump to search
| Line 24: | Line 24: | ||
<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 checkEnumName; | ||
| + | |||
| + | /// Flow | ||
| − | + | checkEnumName = DataType.EnumerationContainsName("EnumerationElement2", EnumerationSignature1); | |
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 08:40, 23 October 2018
Contents
Classification
| Name | EnumerationContainsName |
| Short Description | Checks if the specified enumeration contains the name |
| Class | Term |
| Extension | OTX DataType extension |
| Group | EnumerationContainsName related terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
BooleanTerm = DataType.EnumerationContainsName(StringTerm, OtxLink);Description
EnumerationContainsName is a term to checks if the specified enumeration contains the name.
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 name. |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Name | String | Term | - | [1] | The element name to be checked inside the specified enumeration. |
| Enumeration | OtxLink | - | - | [1] | This attribute identifies the specified enumeration to check the name. The link shall 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 checkEnumName;
/// Flow
checkEnumName = DataType.EnumerationContainsName("EnumerationElement2", EnumerationSignature1);
}See also
EnumerationContainsValue
EnumerationGetEntryList
GetEnumerationByName
GetEnumerationByValue
StructureCopy
