#include <deprecated_ent_err_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. | |
| entity_error_info_legacy (err_mess_type err_mess, spa_outcome_severity_type err_severity, ENTITY *ent1=NULL, ENTITY *ent2=NULL, ENTITY *ent3=NULL) | |
C++ constructor to construct an entity_error_info_legacy object with the specified error number, error severity and a maximum of three entities. | |
| entity_error_info_legacy (err_mess_type err_mess, spa_outcome_severity_type err_severity, const ENTITY_LIST &entities) | |
C++ constructor to construct an entity_error_info_legacy object with the specified error number, error severity and a list of entities. | |
| entity_error_info_legacy () | |
C++ default constructor to construct an entity_error_info_legacy object with no entities in it. | |
| 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. | |
| tag_id_type | get_entity_id (int index) const |
Returns the unique tag_id_type (entity id) of the ENTITY at the given index. | |
| virtual int | get_entity_id_count () const |
Returns the number of entity ids, both alive and dead, that are referred to by this entity_error_info_legacy. | |
| 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. | |
| virtual int | type () const |
| Returns the id number for whichever class this object happens to be. | |
Static Public Member Functions | |
| static int | id () |
Returns the id number for the class entity_error_info_legacy. | |
error_info and additionally stores entity information. Objects of this class are used to return error information along with the associated entities. entity_error_info_legacy is specifically designed to hold entity information in addition to error number and severity that is represented by error_info. This class can be used by those APIs that want to return entity-based error information in their outcome.| entity_error_info_legacy::entity_error_info_legacy | ( | ) |
C++ default constructor to construct an entity_error_info_legacy object with no entities in it.
| entity_error_info_legacy::entity_error_info_legacy | ( | err_mess_type | err_mess, | |
| spa_outcome_severity_type | err_severity, | |||
| const ENTITY_LIST & | entities | |||
| ) |
C++ constructor to construct an entity_error_info_legacy object with the specified error number, error severity and a list of entities.
| err_mess | err_mess_type indicating the error. | |
| err_severity | error severity | |
| entities | list of entities |
| entity_error_info_legacy::entity_error_info_legacy | ( | err_mess_type | err_mess, | |
| spa_outcome_severity_type | err_severity, | |||
| ENTITY * | ent1 = NULL, |
|||
| ENTITY * | ent2 = NULL, |
|||
| ENTITY * | ent3 = NULL | |||
| ) |
C++ constructor to construct an entity_error_info_legacy object with the specified error number, error severity and a maximum of three entities.
| err_mess | err_mess_type indicating the error. | |
| err_severity | error severity | |
| ent1 | first entity | |
| ent2 | second entity | |
| ent3 | third entity |
| 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. |
| tag_id_type entity_error_info_legacy::get_entity_id | ( | int | index | ) | const |
Returns the unique tag_id_type (entity id) of the ENTITY at the given index.
The indexing is zero-based and the maximum index that is valid is one less than the value returned by entity_error_info_legacy::get_entity_id_count(). The pointer to the entity identified by the returned tag_id_type can be obtained by calling the API api_get_entity_from_id(). Note that the entity that is identified by the returned entity id need not be alive, in such a case a call to the API api_get_entity_from_id() with that id would return a NULL entity.
| index | Index at which the entity-id is returned. |
| virtual int entity_error_info_legacy::get_entity_id_count | ( | ) | const [virtual] |
Returns the number of entity ids, both alive and dead, that are referred to by this entity_error_info_legacy.
Each entity id can be obtained by calling entity_error_info_legacy::get_entity_id().
Reimplemented from error_info_base.
| 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 entity_error_info_legacy::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 entity_error_info_legacy::type | ( | ) | const [virtual] |
Returns the id number for whichever class this object happens to be.
If this object is of the class entity_error_info_legacy, then the id number returned by this function would be equal to the one returned by entity_error_info_legacy::id().
Reimplemented from error_info.