Difference between revisions of "Extensions.DataType.EnumerationContainsValue"

From emotive
Jump to navigation Jump to search
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);
Integer EnumerationElement2 = 12);
 
 
public procedure main()
 
public procedure main()
 
{
 
{

Revision as of 09:06, 12 April 2016

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

DataTypes.EnumerationContainsValue(NumericTerm, EnumerationSignature);

Description

EnumerationContainsValue is a term to checks if the specified enumeration contains the value.

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
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 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.EnumerationContainsValue(12, EnumerationSignature1);
}

See also

EnumerationContainsName
EnumerationGetEntryList
GetEnumerationByName
GetEnumerationByValue
StructureCopy