BOSS 8.0.0
BESIII Offline Software System
Loading...
Searching...
No Matches
ers::InvalidReferenceIssue Class Reference

Invalid pointer issue. More...

#include <InvalidReferenceIssue.h>

Inheritance diagram for ers::InvalidReferenceIssue:

Public Member Functions

 InvalidReferenceIssue ()
 InvalidReferenceIssue (const Context &context, severity_t s, const void *pointer, const std::string &message, responsibility_t r=resp_unknown)
virtual const char * get_class_name () const throw ()
 Get key for class (used for serialisation).
 InvalidReferenceIssue ()
 InvalidReferenceIssue (const Context &context, severity_t s, const void *pointer, const std::string &message, responsibility_t r=resp_unknown)
virtual const char * get_class_name () const throw ()
 Get key for class (used for serialisation).
 InvalidReferenceIssue ()
 InvalidReferenceIssue (const Context &context, severity_t s, const void *pointer, const std::string &message, responsibility_t r=resp_unknown)
virtual const char * get_class_name () const throw ()
 Get key for class (used for serialisation).
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.
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
 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.
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
 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.
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 Member Functions

static void check_reference (const Context &context, severity_t s, const void *pointer, const char *ptr_name, responsibility_t r)
static void check_reference (const Context &context, severity_t s, const void *pointer, const char *ptr_name, responsibility_t r)
static void check_reference (const Context &context, severity_t s, const void *pointer, const char *ptr_name, responsibility_t r)

Static Public Attributes

static const char *const CLASS_NAME = "ers::InvalidReferenceIssue"
static const char *const REFERENCE_VALUE_KEY = "REFERENCE_VALUE"
static const char *const REFERENCE_TYPE_KEY = "REFERENCE_TYPE"
static const char *const REFERENCE_NAME_KEY = "REFERENCE_NAME"
static const char *const REFERENCE_C_PTR_TYPE = "C Pointer"
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

void pointer (const void *p)
 InvalidReferenceIssue (const Context &context, severity_t s)
void pointer (const void *p)
 InvalidReferenceIssue (const Context &context, severity_t s)
void pointer (const void *p)
 InvalidReferenceIssue (const Context &context, severity_t s)
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
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
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

Invalid pointer issue.

This issue represents an invalid reference. This class can be used for any type of reference, but most of the present mechanisms are designed for C/C++ memory references, aka. pointers.

Author
Matthias Wiesmann
Version
1.0

Definition at line 26 of file Event/ers/include/ers/InvalidReferenceIssue.h.

Constructor & Destructor Documentation

◆ InvalidReferenceIssue() [1/9]

ers::InvalidReferenceIssue::InvalidReferenceIssue ( const Context & context,
severity_t s )
protected

Definition at line 29 of file InvalidReferenceIssue.cxx.

30 : Issue( context, s ) {}
s
XmlRpcServer s
Definition HelloServer.cpp:11

Referenced by ers::RangeIssue::RangeIssue(), ers::RangeIssue::RangeIssue(), and ers::RangeIssue::RangeIssue().

◆ InvalidReferenceIssue() [2/9]

ers::InvalidReferenceIssue::InvalidReferenceIssue ( )

Definition at line 27 of file InvalidReferenceIssue.cxx.

27: Issue() {}

◆ InvalidReferenceIssue() [3/9]

ers::InvalidReferenceIssue::InvalidReferenceIssue ( const Context & context,
severity_t s,
const void * pointer,
const std::string & message,
responsibility_t r = resp_unknown )

Definition at line 32 of file InvalidReferenceIssue.cxx.

35 : Issue( context, s ) {
36 severity( s );
37 pointer( p );
38 responsibility( r );
39 finish_setup( msg );
40} // InvalidReferenceIssue
ers::Issue::responsibility
responsibility_t responsibility() const
get the responsability level of the issue
Definition ers/src/Issue.cxx:618
ers::Issue::severity
severity_t severity() const
severity_t of the issue
Definition ers/src/Issue.cxx:584
ers::Issue::finish_setup
void finish_setup(const std::string &message)
Finishes the setup of the Issue.
Definition ers/src/Issue.cxx:553

◆ InvalidReferenceIssue() [4/9]

ers::InvalidReferenceIssue::InvalidReferenceIssue ( const Context & context,
severity_t s )
protected

◆ InvalidReferenceIssue() [5/9]

ers::InvalidReferenceIssue::InvalidReferenceIssue ( )

◆ InvalidReferenceIssue() [6/9]

ers::InvalidReferenceIssue::InvalidReferenceIssue ( const Context & context,
severity_t s,
const void * pointer,
const std::string & message,
responsibility_t r = resp_unknown )

◆ InvalidReferenceIssue() [7/9]

ers::InvalidReferenceIssue::InvalidReferenceIssue ( const Context & context,
severity_t s )
protected

◆ InvalidReferenceIssue() [8/9]

ers::InvalidReferenceIssue::InvalidReferenceIssue ( )

◆ InvalidReferenceIssue() [9/9]

ers::InvalidReferenceIssue::InvalidReferenceIssue ( const Context & context,
severity_t s,
const void * pointer,
const std::string & message,
responsibility_t r = resp_unknown )

Member Function Documentation

◆ check_reference() [1/3]

void ers::InvalidReferenceIssue::check_reference ( const Context & context,
severity_t s,
const void * pointer,
const char * ptr_name,
responsibility_t r )
static

Definition at line 53 of file InvalidReferenceIssue.cxx.

55 {
56 if ( p == 0 )
57 {
58 std::ostringstream message;
59 message << "pointer '" << ptr_name << "' is null";
60 ers::InvalidReferenceIssue issue( context, s, p, message.str(), r );
61 issue.m_value_table[REFERENCE_NAME_KEY] = ptr_name;
62 throw issue;
63 } // if
64} // check
ers::Issue::message
const std::string & message() const
Message.
Definition ers/src/Issue.cxx:666

Referenced by check_reference().

◆ check_reference() [2/3]

void ers::InvalidReferenceIssue::check_reference ( const Context & context,
severity_t s,
const void * pointer,
const char * ptr_name,
responsibility_t r )
static

◆ check_reference() [3/3]

void ers::InvalidReferenceIssue::check_reference ( const Context & context,
severity_t s,
const void * pointer,
const char * ptr_name,
responsibility_t r )
static

◆ get_class_name() [1/3]

const char * ers::InvalidReferenceIssue::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::Issue.

Reimplemented in ers::RangeIssue, ers::RangeIssue, and ers::RangeIssue.

Definition at line 42 of file InvalidReferenceIssue.cxx.

42 {
43 return ers::InvalidReferenceIssue::CLASS_NAME;
44} // get_class_name

◆ get_class_name() [2/3]

virtual const char * ers::InvalidReferenceIssue::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::Issue.

Reimplemented in ers::RangeIssue, ers::RangeIssue, and ers::RangeIssue.

◆ get_class_name() [3/3]

virtual const char * ers::InvalidReferenceIssue::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::Issue.

Reimplemented in ers::RangeIssue, ers::RangeIssue, and ers::RangeIssue.

◆ pointer() [1/3]

void ers::InvalidReferenceIssue::pointer ( const void * p)
protected

Definition at line 46 of file InvalidReferenceIssue.cxx.

46 {
47 char buffer[sizeof( void* ) + 1]; // space needed to print a pointer
48 snprintf( buffer, sizeof( buffer ), "%p", p );
49 set_value( REFERENCE_VALUE_KEY, buffer );
50 set_value( REFERENCE_TYPE_KEY, REFERENCE_C_PTR_TYPE );
51} // pointer
ers::Issue::set_value
void set_value(const std::string &key, uint8_t value)
Sets a value 8 bit unsigned.
Definition ers/src/Issue.cxx:363

Referenced by check_reference(), and InvalidReferenceIssue().

◆ pointer() [2/3]

void ers::InvalidReferenceIssue::pointer ( const void * p)
protected

◆ pointer() [3/3]

void ers::InvalidReferenceIssue::pointer ( const void * p)
protected

Member Data Documentation

◆ CLASS_NAME

const char *const ers::InvalidReferenceIssue::CLASS_NAME = "ers::InvalidReferenceIssue"
static

Definition at line 32 of file Event/ers/include/ers/InvalidReferenceIssue.h.

Referenced by get_class_name(), and InvalidReferenceIssue().

◆ REFERENCE_C_PTR_TYPE

const char *const ers::InvalidReferenceIssue::REFERENCE_C_PTR_TYPE = "C Pointer"
static

Definition at line 36 of file Event/ers/include/ers/InvalidReferenceIssue.h.

Referenced by InvalidReferenceIssue(), and pointer().

◆ REFERENCE_NAME_KEY

const char *const ers::InvalidReferenceIssue::REFERENCE_NAME_KEY = "REFERENCE_NAME"
static

Definition at line 35 of file Event/ers/include/ers/InvalidReferenceIssue.h.

Referenced by check_reference(), and InvalidReferenceIssue().

◆ REFERENCE_TYPE_KEY

const char *const ers::InvalidReferenceIssue::REFERENCE_TYPE_KEY = "REFERENCE_TYPE"
static

Definition at line 34 of file Event/ers/include/ers/InvalidReferenceIssue.h.

Referenced by InvalidReferenceIssue(), pointer(), ers::RangeIssue::RangeIssue(), and ers::RangeIssue::set_range().

◆ REFERENCE_VALUE_KEY

const char *const ers::InvalidReferenceIssue::REFERENCE_VALUE_KEY = "REFERENCE_VALUE"
static

Definition at line 33 of file Event/ers/include/ers/InvalidReferenceIssue.h.

Referenced by InvalidReferenceIssue(), pointer(), and ers::RangeIssue::set_range().

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