Difference between revisions of "Extensions.DataType.EnumerationContainsName"
Jump to navigation
Jump to search
(Created page with "{{DISPLAYTITLE:OTX '''EnumerationContainsName'''}}Category:DataTypes == Classification == {{ClassificationActivity | EnumerationContainsName | Checks if the specified enum...") |
|||
| Line 16: | Line 16: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| Name | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | | + | {{TableRowPropertie1| Name | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The element name to be checked inside the specified enumeration.}} |
{{TableRowPropertie2| Enumeration | [[OtxLink]] | - | - | [1] | This attribute identifies the specified enumeration to check the name. The link shall point to the corresponding '''EnumerationSignature'''.}} | {{TableRowPropertie2| Enumeration | [[OtxLink]] | - | - | [1] | This attribute identifies the specified enumeration to check the name. The link shall point to the corresponding '''EnumerationSignature'''.}} | ||
| Line 23: | Line 23: | ||
== 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, | + | package DataTypes.EnumerationSignature EnumerationSignature1(Integer EnumerationElement1 = 7, Integer EnumerationElement2 = 12); |
public procedure main() | public procedure main() | ||
{ | { | ||
Revision as of 09:06, 12 April 2016
Contents
Classification
| Name | EnumerationContainsName |
| Short Description | Checks if the specified enumeration contains the name |
| Class | Term |
| Extension | OTX DataTypes extension |
| Group | EnumerationContainsName related terms |
| Exceptions | - |
| Checker Rules | - |
| Standard Compliant | Yes |
OTL Syntax
DataTypes.EnumerationContainsName(StringTerm, EnumerationSignature);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 DataTypes.EnumerationSignature EnumerationSignature1(Integer EnumerationElement1 = 7, Integer EnumerationElement2 = 12);
public procedure main()
{
Boolean checkEnumName;
checkName = DataTypes.EnumerationContainsName("EnumerationElement2", EnumerationSignature1);
}See also
EnumerationContainsValue
EnumerationGetEntryList
GetEnumerationByName
GetEnumerationByValue
StructureCopy
