|
<NAME>
|
The
Name title indicates to the reader the exact string used to identify the function. This template documents API and DI functions.
|
|
|
Action:
|
The
Action field summarizes what the function does.
|
|
|
Prototype:
|
The
Prototype field shows the function's prototype. If the function is overloaded, all the prototypes are provided.
|
|
|
Includes:
|
The
Includes field lists the
#include files that are needed to define the function's return type, the function's prototype(s), and the data types used in the argument list.
|
|
|
The header files for return types and data types are only those needed to define the
ACIS classes, enumerations, and typedefs used in the function prototype. If a data type is defined in some other way, such as using a
#define statement, the
Includes field may not contain the header file that defines that data type. For example, some functions contain references to the data type
logical, which is defined as equivalent to an
int in the file
logical.h using a
#define statement. The
Includes field does not contain the file
logical.h in such cases.
|
|
|
If the function is overloaded, the
Includes list is cumulative for all the function's prototypes. The standard
ACIS header file,
acis.hxx, is included in all lists.
|
|
|
Description:
|
The
Description field describes the function, its use, and its surrounding conditions.
|
|
|
Errors:
|
The
Errors field lists any error conditions that may occur when the function is called.
|
|
|
Limitations:
|
The
Limitations field lists any limitations of the function. These can include conceptual limitations, such as operations for which the function should not be used, real limitations, such as conditions the function does not support, or platform-specific limitations.
|
|
|
Note
|
The use of term limitations here does not equate to a legal performance standard, rather the term limitation means "additional guidance" regarding the usage.
|
|
|
Library:
|
The
Library field lists the "base name" of the object library file in which the function is defined. The full object library filename is platform and installation dependent. Refer to the chapter
Object Libraries in the
3D ACIS Application Development Manual to determine the full name from the base name.
|
|
|
Filename:
|
The
Filename field specifies the name of the source file, including the directory path, containing the implementation of the function. The first element of the file path is the component's top-level installation directory.
|
|
|
Effect:
|
The
Effect field specifies how the function influences the model:
|
|
|
-
|
"Changes model" means the function causes a change in the model.
|
|
-
|
"Read-only" means the function is an inquiry function that does not change the model.
|
|
-
|
"System routine" means the function performs a system-level function that does not change the model.
|