|
<NAME>
|
The
Name title indicates the exact string used to identify the enumeration. In
C++, an enumeration (enumerated data type) defines a list of constant integer values, each associated with a unique identifier name. Enumerations are defined using the
enum keyword. An enumeration template may document an item that is defined in one of the following ways:
|
|
|
-
|
Using the
enum keyword
|
|
-
|
Using the
typedef enum keyword combination
|
|
-
|
Using the
enum_entry structure
|
|
|
The
ACISenum_entry is used to define a structure that is technically not a
C++ enumerated data type, but is similar. It maps a character string to an integer value (this value is often specified using the identifier from a previously defined
enum). The
enum_entry structure is internal to
ACIS.
|
|
|
Purpose:
|
The
Purpose field summarizes the intended purpose of the enumeration.
|
|
|
Filename:
|
The
Filename field specifies the name of the source file, including the directory path, containing the definition of the enumeration. The first element of the file path is the component's top-level installation directory.
|
|
|
Value:
|
The
Value field lists the possible values for the enumeration. The left column contains the identifier and the right column contains the description. If this was defined using the
enum_entry structure, the right column contains the string associated with each identifier.
|