Macro to mark unimplemented code. More...

#include <NotImplemented.h>

Inheritance diagram for ers::NotImplemented:

Public Member Functions
	NotImplemented ()

	NotImplemented (const Context &context, severity_t s)

virtual const char *	get_class_name () const throw ()
	Get key for class (used for serialisation)

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	CLASS_NAME = "ers::NotImplemented"

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 ()

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

Macro to mark unimplemented code.

This special 'assertion' is used to mark a non implemented function or method. Typically, this is marked using the NOT_IMPLEMENTED() macro.

Author: Matthias Wiesmann �

Version: 1.0

Definition at line 23 of file NotImplemented.h.

Constructor & Destructor Documentation

◆ NotImplemented() [1/2]

ers::NotImplemented::NotImplemented ( )

Definition at line 21 of file NotImplemented.cxx.

21: Assertion() {}

ers::Assertion::Assertion

Assertion()

Definition: Event/ers/ers-00-00-02/src/Assertion.cxx:34

◆ NotImplemented() [2/2]

ers::NotImplemented::NotImplemented	(	const Context &	context,
		severity_t	s
	)

Definition at line 23 of file NotImplemented.cxx.

                                                                : Assertion(c,s) {
    this->setup(c.function().c_str(),"",true);  
} // NotImplemented

Member Function Documentation

◆ build_message()

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

protectedvirtual

Builds the message for a the not implemented issue.

Parameters

condition_text	should contain the problem condition, i.e the part that is not implemented, this should contain the function name or some similar information
msg	an optional message (this is displayed between parentheses).
constant_expression	is the condition constant, this should be the case for not implemented functions.

Returns: A complete information message.

Reimplemented from ers::Assertion.

Definition at line 35 of file NotImplemented.cxx.

                                                                                                                             {
    std::ostringstream message_stream ;
    (void) constant_expression ; 
    message_stream << "Function in " << condition_text ;
    if (! msg.empty()) {
    message_stream << "(" << msg << ")" ; 
    }
    message_stream << " is not implemented" ;
    return message_stream.str(); 
} // build_message

◆ get_class_name()

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

virtual

Get key for class (used for serialisation)

Returns the key used to describe this particular class when serializing This method tries to build a meaningfull class name out of C++ RTTI. This depends on the compiler providing information in a format similar to gcc. For more safety. If the gcc unmangling fails the default (ers::Issue) is used.

Reimplemented from ers::Assertion.

Definition at line 47 of file NotImplemented.cxx.

47{ return CLASS_NAME ;}

ers::NotImplemented::CLASS_NAME

static const char *const CLASS_NAME

Definition: NotImplemented.h:28

Member Data Documentation

◆ CLASS_NAME

const char *const ers::NotImplemented::CLASS_NAME = "ers::NotImplemented"

static

Definition at line 28 of file NotImplemented.h.

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members