ers::Precondition Class Reference

Precondition issue. More...

#include <Precondition.h>

Inheritance diagram for ers::Precondition:

Public Member Functions
	Precondition ()
	Precondition (const Context &context, severity_t s, const char *condition, const std::string &message, bool constant_expression=false)
virtual const char *	get_class_name () const throw ()
Public Member Functions inherited from ers::Assertion
virtual const char *	get_class_name () const throw ()
	Get key for class (used for serialisation)
	Assertion ()
	Assertion (const Context &context, severity_t s, const char *condition, const std::string &message, bool constant_expression=false)
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	PRECONDITION_CLASS = "ers::Precondition"
Static Public Attributes inherited from ers::Assertion
static const char *const	ASSERT_CONDITION_KEY = "ASSERTION_CONDITION"
static const char *const	CLASS_NAME = "ers::Assertion"
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
virtual std::string	build_message (const char *condition_text, const std::string &message, bool constant_expression=false) throw ()
	Precondition (const Context &context, severity_t s)
Protected Member Functions inherited from ers::Assertion
virtual std::string	build_message (const char *condition_text, const std::string &msg, bool constant_expression=false) throw ()
	Assertion (const Context &context, severity_t s)
void	setup (const char *condition, const std::string &message, bool constant_expression)
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.
Static Protected Attributes inherited from ers::Assertion
static const char *const	MESSAGE_ELEMENTS [] = { "Assertion '", "' failed: ", " (this condition is constant)" }

Detailed Description

Precondition issue.

A precondition is a special type of assertion that checks the entry condition for a function. Typically, precondition check entry values for function, and members state in object methods

Author

Matthias Wiesmann

Version

1.0

Definition at line 24 of file Precondition.h.

Constructor & Destructor Documentation

Precondition() [1/3]

ers::Precondition::Precondition ( const Context &  c, severity_t  s  )

protected

Constructor used by subclasses

Parameters

c	context of the issue
s	severity_t of the issue
c	context of the issue

Definition at line 32 of file Precondition.cxx.

: Assertion(c,s) {}  

Precondition() [2/3]

ers::Precondition::Precondition

(

)

Constructor used by deserialisation

Definition at line 24 of file Precondition.cxx.

: Assertion() {} 

Precondition() [3/3]

ers::Precondition::Precondition	(	const Context &	context,
		severity_t	s,
		const char *	condition,
		const std::string &	msg,
		bool	constant_expression = false
	)

Main constructor, it should be used for building Precondition Issues

Parameters

context	context of the issue
s	severity_t of the issue
condition	text of the condition of the precondition
msg	message for condition
constant_expression	does compiler think expression is constant

Definition at line 42 of file Precondition.cxx.

                                                                                                                                         : Assertion(context,s) {
    this->setup(condition,msg,constant_expression); 
} // Precondition

Member Function Documentation

build_message()

std::string ers::Precondition::build_message ( const char *  condition_text, const std::string &  msg, bool  constant_expression = false  ) throw ( )

protectedvirtual

Builds the message associated with an assertion

Parameters

condition_text	the condition in textual form
msg	the message associated with the condition
constant_expression	is the condition constant (as detected by compiler).

Returns

message describing the failure of the assertion

Reimplemented from ers::Assertion.

Definition at line 57 of file Precondition.cxx.

                                                                                                                           {
    std::ostringstream m ;
    m << "Precondition '" << condition_text << "' failed: " << msg ;
    if (constant_expression) {
    m << " (this condition is constant)" ; 
    } // constant expression 
    return m.str();
} // build_message

get_class_name()

const char * ers::Precondition::get_class_name ( ) const throw ( )

virtual

Returns

name key for the class

Reimplemented from ers::Assertion.

Definition at line 48 of file Precondition.cxx.

{ return PRECONDITION_CLASS ;} 

Member Data Documentation

PRECONDITION_CLASS

const char *const ers::Precondition::PRECONDITION_CLASS = "ers::Precondition"

static

Definition at line 29 of file Precondition.h.

---

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

• Precondition.h
• Precondition.cxx