ErrorStoreBase.hxx File Reference

#include <set>
#include <stdio.h>
#include <stdlib.h>
#include <string>
#include <unidefs.h>
#include <vector>
#include <base_utils/libbase_utils_exports.h>
#include <base_utils/libbase_utils_undef.h>

Go to the source code of this file.

Classes
class	Teamcenter::ErrorStoreBase

Namespaces
namespace	Teamcenter
	A convenient C++ class to manage a list of tag_t. This convenient class is derived from TagList class which is only available for internal developers.
namespace	Teamcenter::Logging::Metrics

Functions
int	Teamcenter::Logging::Metrics::getSessionErrorCount ()
int	Teamcenter::Logging::Metrics::getSessionTracebackCount ()
void	Teamcenter::Logging::Metrics::incrementSessionErrorCount ()
void	Teamcenter::Logging::Metrics::incrementSessionTracebackCount ()

Detailed Description

This file contains the declarations of the ErrorStoreBase class in module libbase_utils. ErrorStoreBase is the keeper of error codes raised by ERROR_raise() in libsyss. ErrorStoreBase is a singleton, which can be accessed through the static function Teamcenter::ErrorStoreBase::getInstance(). The system (Teamcenter) needs to do the following in order to fully initialise ErrorStore functionality:

1. implement a decoder function that translates an error code into an internationalized error message (something like EMH_get_err_string())
2. this decoder function must set its return value and success/failure flag via libbase_utils Teamcenter::ErrorStoreBase::set_error_string()
3. register this decoder function once per session via libbase_utils Teamcenter::ErrorStoreBase::set_decoder_function(...) (e.g. in ERROR_store_init_table())
4. register this decoder function for various error code ranges via libsyss ERROR_register_decoder_fn() (e.g. in ERROR_store_init_table())

Definition in file ErrorStoreBase.hxx.