#include <stde_info.hxx>
Public Member Functions | |
| void | add () |
| Increments the use count. | |
| void | add_entities (const ENTITY_LIST &entities) |
Adds entities to this error_info, if not already there. | |
| void | add_entity (ENTITY *ent) |
Adds an entity to this error_info, if not already there. | |
| char const * | error_message () const |
Returns the message string of the error that this error_info_base object is encapsulating. | |
| err_mess_type | error_number () const |
Returns the error number of the error that this error_info_base object is encapsulating. | |
| i_aux_data_holder * | get_aux_data () const |
Queries the auxiliary data provided by this error_info object. | |
| void | get_entities_alive (ENTITY_LIST &entities) const |
Adds all the alive entities that belong to this error_info to the incoming list of ENTITYs. | |
| logical | has_reasons () const |
Returns TRUE if this error_info_base object has at least one reason; returns FALSE otherwise. | |
| void | reasons (error_info_base_list &err_reasons) const |
Adds all the reasons of this error_info_base into the given list, err_reasons. | |
| void | reasons (error_info_list &err_reasons) const |
Adds all the reasons of this error_info to the given list, err_reasons. | |
| void | remove () |
| Decrements the use count. | |
| spa_outcome_severity_type | severity () const |
Returns the severity of the error that this error_info_base object is encapsulating. | |
| standard_error_info (ENTITY *e0=NULL, ENTITY *e1=NULL) | |
| C++ initialize constructor requests memory for this object and populates it with the data supplied as arguments. | |
| virtual int | type () const |
| Returns the id number for whichever class this object happens to be. | |
| virtual | ~standard_error_info () |
C++ destructor, deleting a standard_error_info. | |
Static Public Member Functions | |
| static int | id () |
Returns the id number for the class standard_error_info. | |
Public Attributes | |
| ENTITY * | entity0 |
| First entity with standard error information. | |
| logical | entity0_dead |
Flag that warns whether the returned entity0 will be deleted on rollback. | |
| ENTITY * | entity1 |
| Second entity with standard error information. | |
| logical | entity1_dead |
Flag that warns whether the returned entity1 will be deleted on rollback. | |
Role: 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 upon 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.
C++ initialize constructor requests memory for this object and populates it with the data supplied as arguments.
| e0 | Pointer to first entity associated with the error. | |
| e1 | Pointer to second entity associated with the error. |
| virtual standard_error_info::~standard_error_info | ( | ) | [virtual] |
C++ destructor, deleting a standard_error_info.
| void error_info_base::add | ( | ) | [inherited] |
Increments the use count.
Customers should only have to pay attention to use counting if they explicitly call add.
| void error_info::add_entities | ( | const ENTITY_LIST & | entities | ) | [inherited] |
Adds entities to this error_info, if not already there.
Any dead entity in the given list would not get added.
| entities | ENTITY_LIST to add |
| void error_info::add_entity | ( | ENTITY * | ent | ) | [inherited] |
Adds an entity to this error_info, if not already there.
| ent | pointer to an ENTITY that is to be added. This should not point to a NULL or a dead entity. |
| char const* error_info_base::error_message | ( | ) | const [inherited] |
Returns the message string of the error that this error_info_base object is encapsulating.
| err_mess_type error_info_base::error_number | ( | ) | const [inherited] |
Returns the error number of the error that this error_info_base object is encapsulating.
| i_aux_data_holder* error_info::get_aux_data | ( | ) | const [inherited] |
Queries the auxiliary data provided by this error_info object.
Returns NULL if no additional/auxiliary information is available. Note that the object (i.e., the i_aux_data_holder) returned by this function is owned by the caller and the memory needs to be cleaned up after use.
| void error_info::get_entities_alive | ( | ENTITY_LIST & | entities | ) | const [inherited] |
Adds all the alive entities that belong to this error_info to the incoming list of ENTITYs.
Note that this method does not clear the given list of entities.
| entities | ENTITY_LIST to which the alive entities are added. |
| logical error_info_base::has_reasons | ( | ) | const [inherited] |
Returns TRUE if this error_info_base object has at least one reason; returns FALSE otherwise.
| static int standard_error_info::id | ( | ) | [static] |
| void error_info_base::reasons | ( | error_info_base_list & | err_reasons | ) | const [inherited] |
Adds all the reasons of this error_info_base into the given list, err_reasons.
In some cases, an error_info_base may need to provide some additional information about the errors or problems that would have caused the error that is indicated by this error_info_base object. These additional errors and problems are stored as reasons. For example, an error_info_base object encapsulating the error 'Operation failed due to check errors' might include the list of check errors in the 'reasons' list.
| err_reasons | error_info_base_list to which the reasons are added. |
| void error_info::reasons | ( | error_info_list & | err_reasons | ) | const [inherited] |
Adds all the reasons of this error_info to the given list, err_reasons.
In some cases, error_info may need to provide some additional information about the errors or problems that would have caused the error that is indicated by this error_info object. These additional errors and problems are stored as 'reasons'. For example, an error_info object encapsulating the error 'Operation failed due to check errors' might include the list of check errors in the 'reasons' list.
| err_reasons | error_info_list to which the reasons are added |
| void error_info_base::remove | ( | ) | [inherited] |
Decrements the use count.
Customers should only have to pay attention to use counting if they explicitly call add.
| spa_outcome_severity_type error_info_base::severity | ( | ) | const [inherited] |
Returns the severity of the error that this error_info_base object is encapsulating.
| virtual int standard_error_info::type | ( | ) | const [virtual] |
Returns the id number for whichever class this object happens to be.
If this object is of the class standard_error_info, then the id number returned by this function would be equal to the one returned by standard_error_info::id.
Reimplemented from error_info.
First entity with standard error information.
Flag that warns whether the returned entity0 will be deleted on rollback.
Second entity with standard error information.
Flag that warns whether the returned entity1 will be deleted on rollback.