KnowledgeInterfaces Interface CATIEnumere

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIEnumere

Interface dedicated to enumerated types management.
Role: This interface gives access to enumerated types properties.
Enumerated types also implement CATICkeType
An enumerated type is a parameter type that allows only a list of identified string values

See also:
,


Method Index


o Find(CATUnicodeString&)
Finds the rank (1 to N) of an enum value from its string.
o Values(CATListOfCATUnicodeString*)
Returns the pre-definite list of values allowed for this type.

Methods


o Find
public virtual Find( const iValue)
Finds the rank (1 to N) of an enum value from its string.
Parameters:
iValue
value to be found
Returns:
rank of the value from 1 to N if found (else 0)
Legal values: 1 to N rank of the value in the list if found. 0 if value hasn't been found.
o Values
public virtual Values( iListNLSNames= NULL)
Returns the pre-definite list of values allowed for this type.
Parameters:
iListNLSNames
if not NULL, this list is filled with NLS name of values.
The mechanism to find NLS name for the value is to find it in the NLS msgcatalog file which corresponds to the .feat catalog in which the enumere is.
Returns:
list of values not to be deallocated !!!.

This object is included in the file: CATIEnumere.h
If needed, your Imakefile.mk should include the module: KnowledgeItf

Copyright © 1999-2015, Dassault Systèmes. All rights reserved.