Purpose:
|
Returns standard error information.
|
|
Derivation:
|
standard_error_info : error_info : ACIS_OBJECT : -
|
|
Filename:
|
kern/kernel/kernutil/errorsys/stde_info.hxx
|
|
Description:
|
This class contains standard error information, which is sufficient for use in many circumstances. For example, when working in the
Local Operations Component, if unable to solve for an
EDGE, the error
LOP_TWK_NO_EDGE will produce an
outcome that points to a standard error info object. The argument
entity0 will be set to the
EDGE in question.
|
|
|
This class also contains flags that warn the user if the returned
ENTITY will be deleted on roll back.
|
|
|
Two overloaded versions of the function
sys_error set a global pointer to an
error_info object. One version is passed an
error_info object, and the other creates a
standard_error_info object when
sys_error is passed one or two
ENTITYs. The
standard_error_info class is derived from
error_info, which provides error data that is adequate in a majority of cases, such as local operations and blending.
|
|
|
In the
Local Ops,
Remove Faces, and
Shelling Components, the
error_info object returns an
ENTITY that further specifies where the local operation first fails, when such information is available. A
standard_error_info object is adequate for use in these components, and more detailed information could be returned, if necessary, by deriving a new class.
|
|
References:
|
KERN
|
ENTITY
|
|
Data:
|
public ENTITY *entity0;
|
|
First entity with standard error information.
|
|
|
public ENTITY *entity1;
|
|
Second entity with standard error information.
|
|
|
public logical entity0_dead;
|
|
Flag that warns whether the returned
entity0 will be deleted on rollback.
|
|
|
public logical entity1_dead;
|
|
Flag that warns whether the returned
entity1 will be deleted on rollback.
|
|
Constructor:
|
public: standard_error_info::standard_error_info
(
|
|
|
ENTITY* e0
|
// Pointer to first
|
|
|
|
= NULL,
|
// entity with error
|
|
|
ENTITY* e1
|
// Pointer to second
|
|
|
|
= NULL
|
// entity with error
|
|
|
);
|
|
|
C++ initialize constructor requests memory for this object and populates it with the data supplied as arguments.
|
|
|
|
|
Destructor:
|
public: virtual
|
|
|
standard_error_info::~standard_error_info ();
|
|
|
C++ destructor, deleting a
standard_error_info.
|
|
|
|
Methods:
|
public: static int standard_error_info::id
();
|
|
|
Identifies the standard error object.
|
|
|
|
|
|
|
public: virtual int
|
|
|
standard_error_info::type () const;
|
|
|
Returns the string "standard_error_info".
|