PolyBoRi
Public Types | Public Member Functions | Protected Attributes | List of all members
polybori::PBoRiError Class Reference

This class is used for polybori's exception handling. More...

#include <PBoRiError.h>

Inheritance diagram for polybori::PBoRiError:
polybori::CTypes polybori::COrderEnums polybori::CErrorEnums polybori::CCompareEnums polybori::CAuxTypes polybori::PBoRiGenericError< ErrorCode >

Public Types

typedef CTypes::errornum_type errornum_type
 adopt global error code enumeration More...
 
typedef CTypes::errortext_type errortext_type
 adopt global error text type More...
 
typedef PBoRiError self
 generic access to type of *this More...
 
- Public Types inherited from polybori::CTypes
typedef COrderEnums orderenums_type
 
typedef CErrorEnums errorenums_type
 
typedef CCompareEnums compenums_type
 
typedef CAuxTypes auxtypes_type
 
- Public Types inherited from polybori::COrderEnums
enum  ordercodes {
  lp, dlex, dp_asc, block_dlex,
  block_dp_asc
}
 Codes For orderings. More...
 
- Public Types inherited from polybori::CErrorEnums
enum  errorcodes {
  alright = 0, failed, no_ring, invalid,
  out_of_bounds, io_error, monomial_zero, illegal_on_zero,
  division_by_zero, invalid_ite, not_implemented, matrix_size_exceeded,
  last_error
}
 Error codes enumeration. More...
 
- Public Types inherited from polybori::CCompareEnums
enum  comparecodes {
  less_than = -1, equality = 0, greater_than = +1, less_or_equal_max = 0,
  greater_or_equal_min = 0
}
 Comparision codes enumeration. More...
 
enum  { max_idx = CUDD_MAXINDEX }
 
- Public Types inherited from polybori::CAuxTypes
typedef bool bool_type
 Type for standard true/false statements. More...
 
typedef std::size_t size_type
 Type for lengths, dimensions, etc. More...
 
typedef int deg_type
 Type for polynomial degrees (ranges from -1 to maxint) More...
 
typedef int integer_type
 Type for integer numbers. More...
 
typedef int idx_type
 Type for indices. More...
 
typedef std::size_t hash_type
 Type for hashing. More...
 
typedef unsigned int errornum_type
 Type used to store error codes. More...
 
typedef short int comp_type
 Type for comparisons. More...
 
typedef int ordercode_type
 Type for ordering codes. More...
 
typedef const char * errortext_type
 Type used to verbose error information. More...
 
typedef std::ostream ostream_type
 Type for out-stream. More...
 
typedef const char * vartext_type
 Type for setting/getting names of variables. More...
 
typedef unsigned long large_size_type
 large size_type (necessary?) More...
 
typedef std::size_t refcount_type
 Type for counting references. More...
 

Public Member Functions

 PBoRiError (errornum_type err=CTypes::alright)
 construct instance from error code More...
 
 PBoRiError (const self &)
 copy constructor More...
 
 ~PBoRiError () throw ()
 destructor More...
 
errornum_type code () const
 get error code More...
 
errortext_type text () const
 get error text More...
 
const char * what () const throw ()
 std::exception compatible interface More...
 

Protected Attributes

errornum_type error
 

Additional Inherited Members

- Static Public Member Functions inherited from polybori::CTypes
static idx_type max_index ()
 Type of interface to binary decicion diagrams. More...
 

Detailed Description

This class is used for polybori's exception handling.

It's mainly a class wrapper for CTypes::errorcode.

Member Typedef Documentation

typedef CTypes::errornum_type polybori::PBoRiError::errornum_type

adopt global error code enumeration

adopt global error text type

generic access to type of *this

Constructor & Destructor Documentation

polybori::PBoRiError::PBoRiError ( errornum_type  err = CTypes::alright)

construct instance from error code

References PBORI_TRACE_FUNC.

polybori::PBoRiError::PBoRiError ( const self rhs)

copy constructor

References PBORI_TRACE_FUNC.

polybori::PBoRiError::~PBoRiError ( ) throw ()

destructor

References PBORI_TRACE_FUNC.

Member Function Documentation

PBoRiError::errornum_type polybori::PBoRiError::code ( ) const

get error code

References error, and PBORI_TRACE_FUNC.

PBoRiError::errortext_type polybori::PBoRiError::text ( ) const

get error text

References error, PBORI_TRACE_FUNC, and polybori::CErrorInfo::text().

const char* polybori::PBoRiError::what ( ) const throw ()
inline

std::exception compatible interface

Member Data Documentation

errornum_type polybori::PBoRiError::error
protected

Referenced by code(), and text().


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