Extensions.DataType.EnumerationContainsValue

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

Boolean BooleanVariable;
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 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 checkEnumValue;

        /// Flow

        checkEnumValue = DataType.EnumerationContainsValue(12, EnumerationSignature1);
}

See also

EnumerationContainsName
EnumerationGetEntryList
GetEnumerationByName
GetEnumerationByValue
StructureCopy