Public Member Functions | List of all members
exception< type > Class Template Reference

#include <pybind11.h>

Inheritance diagram for exception< type >:
Inheritance graph
[legend]

Public Member Functions

 exception ()=default
 
 exception (handle scope, const char *name, handle base=PyExc_Exception)
 
void operator() (const char *message)
 
- Public Member Functions inherited from object
template<typename T >
T cast () const &
 
template<typename T >
T cast ()&&
 
template<>
void cast () const &
 
template<>
void cast ()&&
 
 object ()=default
 
 object (const object &o)
 Copy constructor; always increases the reference count. More...
 
 object (object &&other) noexcept
 Move constructor; steals the object from other and preserves its reference count. More...
 
 object (handle h, borrowed_t)
 
 object (handle h, stolen_t)
 
objectoperator= (const object &other)
 
objectoperator= (object &&other) noexcept
 
 PYBIND11_DEPRECATED ("Use reinterpret_borrow<object>() or reinterpret_steal<object>()") object(handle h
 
handle release ()
 
 ~object ()
 Destructor; automatically calls handle::dec_ref() More...
 
- Public Member Functions inherited from handle
template<typename T >
T cast () const
 
template<>
void cast () const
 
bool check () const
 
const handledec_ref () const &
 
 handle ()=default
 The default constructor creates a handle with a nullptr-valued pointer. More...
 
 handle (PyObject *ptr)
 Creates a handle from the given raw Python object pointer. More...
 
const handleinc_ref () const &
 
 operator bool () const
 Return true when the handle wraps a valid Python object. More...
 
bool operator!= (const handle &h) const
 
bool operator== (const handle &h) const
 
PyObject * ptr () const
 Return the underlying PyObject * pointer. More...
 
PyObject *& ptr ()
 

Additional Inherited Members

- Public Attributes inherited from object
bool is_borrowed: handle(h) { if (is_borrowed) inc_ref()
 
- Protected Attributes inherited from handle
PyObject * m_ptr = nullptr
 

Detailed Description

template<typename type>
class exception< type >

Wrapper to generate a new Python exception type.

This should only be used with PyErr_SetString for now. It is not (yet) possible to use as a py::base. Template type argument is reserved for future use.

Definition at line 1870 of file pybind11.h.

Constructor & Destructor Documentation

template<typename type >
exception< type >::exception ( )
default
template<typename type >
exception< type >::exception ( handle  scope,
const char *  name,
handle  base = PyExc_Exception 
)
inline

Definition at line 1873 of file pybind11.h.

Member Function Documentation

template<typename type >
void exception< type >::operator() ( const char *  message)
inline

Definition at line 1884 of file pybind11.h.


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


gtsam
Author(s):
autogenerated on Sat May 8 2021 02:51:47