ExampleIssue Class Reference

Example issue. More...

#include <ExampleIssue.h>

Inheritance diagram for ExampleIssue:

Public Member Functions
	ExampleIssue ()
	ExampleIssue (const ers::Context &context, ers::severity_t severity, int procrastination_level)
virtual const char *	get_class_name () const throw ()
int	procrastination_level () const
Public Member Functions inherited from ers::Issue
	Issue ()
	Issue (const Issue &issue)
	Issue (const string_map_type &values)
	Issue (const Context &context, severity_t s, const std::string &message)
	Issue (const Context &context, severity_t s, const std::exception *cause)
virtual	~Issue () throw ()
Issue *	clone () const
const Issue *	cause () const throw ()
	return the cause Issue of this Issue
void	cause (const std::exception *cause=0)
	Initialises the cause field.
	operator std::string () const
	Converts the issue into a string.
Issue	operator= (const Issue &issue)
	Affectation operator.
bool	operator== (const Issue &other) const throw ()
	Equality operator.
const std::string &	operator[] (const std::string &key) const throw ()
const std::string &	get_value (const std::string &key, const std::string &def) const throw ()
	Reads the property list.
const std::string &	get_value (const std::string &key) const throw ()
int	get_int_value (const std::string &key, int def=0) const throw ()
	Get a value of the table as an integer.
long	get_long_value (const std::string &key, long def=0) const throw ()
	Get a value of the table as a long integer.
double	get_double_value (const std::string key, double def) const throw ()
	Get a value of the table as double.
void	set_value (const std::string &key, uint8_t value) throw ()
	Sets a value 8 bit unsigned.
void	set_value (const std::string &key, uint16_t value) throw ()
void	set_value (const std::string &key, uint32_t value) throw ()
void	set_value (const std::string &key, uint64_t value) throw ()
void	set_value (const std::string &key, int8_t value) throw ()
void	set_value (const std::string &key, int16_t value) throw ()
void	set_value (const std::string &key, int32_t value) throw ()
void	set_value (const std::string &key, int64_t value) throw ()
void	set_value (const std::string &key, double value) throw ()
	Sets a value (double float)
void	set_value (const std::string &key, const std::string &value) throw ()
	Sets a value (string)
void	set_value (const std::string &key, const char *value) throw ()
	Sets a value (c-string)
void	set_value (const std::string &key, const void *ptr) throw ()
int	values_number () const
	How many key / values.
virtual const char *	get_class_name () const throw ()
	Get key for class (used for serialisation)
const string_map_type *	get_value_table () const
	extract value table
severity_t	severity () const throw ()
	severity_t of the issue
void	severity (severity_t s)
	sets the severity_t of the issue
bool	is_error ()
	is the issue an error (or fatal).
std::string	severity_message () const
	message associated with the severity_t of the issue
void	responsibility (responsibility_t r)
	set the responsability of the issue
responsibility_t	responsibility () const throw ()
	get the responsability level of the issue
void	transience (bool tr)
	sets if the issue is transient
int	transience () const throw ()
	is the issue transient
const std::string &	human_description () const throw ()
	Human description message.
const char *	what () const throw ()
	Human description message.
const std::string &	message () const throw ()
	Message.
virtual int	exit_value () const throw ()
	value to pass to exit
void	add_qualifier (const std::string &qualif)
	adds a qualifier to the issue
std::vector< std::string >	qualifiers () const
	return array of qualifiers

Static Public Attributes
static const char *const	CLASS_NAME = "ExampleIssue"
static const char *const	PROCRASTINATION_LEVEL_KEY = "PROCRASTINATION_LEVEL"
Static Public Attributes inherited from ers::Issue
static const char *const	CLASS_KEY = "ISSUE_CLASS"
	key for class information
static const char *const	COMPILATION_TIME_KEY = "COMPILATION_TIME"
	key for compilation time
static const char *const	COMPILATION_TARGET_KEY = "COMPILATION_TARGET"
	key for compilation target
static const char *const	COMPILER_KEY = "COMPILER"
	key for compilator type
static const char *const	COMPILATION_DEBUG_LVL_KEY = "COMPILATION_DEBUG_LVL"
static const char *const	CPP_CLASS_KEY = "ISSUE_CPP_CLASS"
	key for c++ class (might be mangled)
static const char *const	ERS_VERSION_KEY = "ERS_VERSION"
	key for ERS version
static const char *const	HOST_NAME_KEY = "HOST_NAME"
	key for hostname
static const char *const	HOST_TYPE_KEY = "HOST_TYPE"
	key for host type (architecture / os)
static const char *const	HOST_IP_ADDR_KEY = "HOST_IP"
	key for host ip address
static const char *const	MESSAGE_KEY = "MESSAGE"
	key for human readable
static const char *const	PROCESS_ID_KEY = "PROCESS_ID"
	key for the process id (number)
static const char *const	PROCESS_PWD_KEY = "PROCESS_PWD"
	key for the process working directory
static const char *const	PROGRAM_NAME_KEY = "PROGRAM_NAME"
	key for the name of the program
static const char *const	RESPONSIBILITY_KEY = "RESPONSIBILITY"
	key for the responsibility of the issue (text)
static const char *const	SEVERITY_KEY = "SEVERITY"
	key for the severity_t of the issue
static const char *const	SOURCE_POSITION_KEY = "SOURCE_POSITION"
	key for position in the source code
static const char *const	SOURCE_PACKAGE_KEY = "SOURCE_PACKAGE"
	package name associated with source code
static const char *const	TIME_KEY = "TIME"
	key for the time of the issue (text)
static const char *const	TRANSIENCE_KEY = "TRANSIENCE"
	key for the transience of the issue (text)
static const char *const	USER_ID_KEY = "USER_ID"
	key for the user-id of the owner of the process
static const char *const	USER_NAME_KEY = "USER_NAME"
	key for the user-name of the owner of the process
static const char *const	CAUSE_PSEUDO_KEY = "CAUSE"
	key used when serializing the cause issue, this key is not used in the value table
static const char *const	CAUSE_TEXT_KEY = "CAUSE_TEXT"
	key used to store the cause issue's message
static const char *const	QUALIFIER_LIST_KEY = "QUALIFIERS"
	key used to store the qualifier list
static const char *const	EXIT_VALUE_KEY = "EXIT_VALUE"
	key used to store the exit value
static const char *const	ISSUE_CLASS_NAME = "ers::issue"
	name of the class, used for serialisation

Protected Member Functions
	ExampleIssue (const ers::Context &context, ers::severity_t severity)
Protected Member Functions inherited from ers::Issue
void	insert (const Context *context) throw ()
	Inserts the context.
void	insert_time () throw ()
	Inserts current time.
void	setup_common (const Context *context) throw ()
	Sets up the common fields.
void	finish_setup (const std::string &message) throw ()
	Finishes the setup of the Issue.
	Issue (const Context &context, severity_t s)
	Constructor for subclasses.
void	set_values (const string_map_type &values) throw ()
	sets the value table

Additional Inherited Members
Protected Attributes inherited from ers::Issue
Issue *	m_cause
	Issue that caused the current issue.
std::string	m_class_name
	class name
std::string	m_human_description
	Human readable description (cache)
string_map_type	m_value_table
	Optional properties.

Detailed Description

Example issue.

This class is an example of an user issue. It contains a integer member field

Author

Matthias Wiesmann

Version

1.0

Definition at line 20 of file ExampleIssue.h.

Constructor & Destructor Documentation

ExampleIssue() [1/3]

ExampleIssue::ExampleIssue ( const ers::Context &  context, ers::severity_t  severity  )

protected

Definition at line 40 of file ExampleIssue.cxx.

: ers::Issue(context,severity) {}

ExampleIssue() [2/3]

ExampleIssue::ExampleIssue

(

)

Definition at line 38 of file ExampleIssue.cxx.

: ers::Issue() {} 

ExampleIssue() [3/3]

ExampleIssue::ExampleIssue	(	const ers::Context &	context,
		ers::severity_t	severity,
		int	procrastination_level
	)

User constructor, this constructor should be used by the user. The prototype includes the two mandatory parameters, context and severity plus whatever custome construction parameters are needed.

Parameters

context	object representing the code-context where the issue originated, normally, this is the macro ERS_HERE
severity	the severity of the issue
procrastination_level	this is a custom parameter needed by this example issue

Definition at line 50 of file ExampleIssue.cxx.

                                                                                                       : ers::Issue(context,severity) {
    set_value(PROCRASTINATION_LEVEL_KEY,procrastination_level) ; 
    std::ostringstream msg_str ; 
    msg_str << "Procrastinating at level " << procrastination_level ; 
    finish_setup(msg_str.str()); 
} // ExampleIssue

Member Function Documentation

get_class_name()

const char * ExampleIssue::get_class_name ( ) const throw ( )

virtual

This function returns the name of the Issue, this name should be the same as the unmangled class name. Here we given back the string defined in ExampleIssue::CLASS_NAME

Note

If this function is not defined, the implementation the Issue root object tries to build a meaningfull name out of RTTI information, but depending on the compiler this is unreliable.

Returns

name of the class

Reimplemented from ers::Issue.

Definition at line 73 of file ExampleIssue.cxx.

                                                       {
    return ExampleIssue::CLASS_NAME ; 
} // get_class_name

procrastination_level()

int ExampleIssue::procrastination_level

(

)

const

This method is an example of an accessor for a custom property in the issue It basically searches the value table for the right property and returns it.

Returns

the value of the procrastination property

Definition at line 62 of file ExampleIssue.cxx.

                                              {
    return get_int_value(PROCRASTINATION_LEVEL_KEY); 
} // procrastination_level

Referenced by ExampleIssue().

Member Data Documentation

CLASS_NAME

const char *const ExampleIssue::CLASS_NAME = "ExampleIssue"

static

Definition at line 25 of file ExampleIssue.h.

Referenced by get_class_name().

PROCRASTINATION_LEVEL_KEY

const char *const ExampleIssue::PROCRASTINATION_LEVEL_KEY = "PROCRASTINATION_LEVEL"

static

Definition at line 26 of file ExampleIssue.h.

Referenced by ExampleIssue(), and procrastination_level().

---

The documentation for this class was generated from the following files:

• ExampleIssue.h
• ExampleIssue.cxx