BoB robotics
The Brains on Board robotics library
Public Types | Public Member Functions | List of all members
pybind11::enum_< Type > Class Template Reference

Binds C++ enumerations and enumeration classes to Python. More...

#include <pybind11.h>

Inheritance diagram for pybind11::enum_< Type >:
pybind11::class_< Type > pybind11::detail::generic_type pybind11::object pybind11::handle pybind11::detail::object_api< handle > pybind11::detail::pyobject_tag

Public Types

using Base = class_< Type >
 
using Underlying = typename std::underlying_type< Type >::type
 
using Scalar = detail::conditional_t< detail::any_of< detail::is_std_char_type< Underlying >, std::is_same< Underlying, bool > >::value, detail::equivalent_integer_t< Underlying >, Underlying >
 
- Public Types inherited from pybind11::class_< Type >
using type = Type
 
using type_alias = detail::exactly_one_t< is_subtype, void, options... >
 
using holder_type = detail::exactly_one_t< is_holder, std::unique_ptr< type >, options... >
 

Public Member Functions

template<typename... Extra>
 enum_ (const handle &scope, const char *name, const Extra &... extra)
 
enum_ & export_values ()
 Export enumeration entries into the parent scope.
 
enum_ & value (char const *name, Type value, const char *doc=nullptr)
 Add an enumeration entry.
 
- Public Member Functions inherited from pybind11::class_< Type >
 __attribute__ ((deprecated("Use reinterpret_borrow<""class_"">() or reinterpret_steal<""class_"">()"))) class_(handle h
 
bool typename Extra class_ & def (const char *name_, Func &&f, const Extra &... extra)
 
class_ & def (const detail::op_< id, ot, L, R > &op, const Extra &... extra)
 
class_ & def (const detail::initimpl::constructor< Args... > &init, const Extra &... extra)
 
class_ & def (const detail::initimpl::alias_constructor< Args... > &init, const Extra &... extra)
 
class_ & def (detail::initimpl::factory< Args... > &&init, const Extra &... extra)
 
class_ & def (detail::initimpl::pickle_factory< Args... > &&pf, const Extra &...extra)
 
class_ & def_static (const char *name_, Func &&f, const Extra &... extra)
 
class_ & def_cast (const detail::op_< id, ot, L, R > &op, const Extra &... extra)
 
class_ & def_buffer (Func &&func)
 
class_ & def_buffer (Return(Class::*func)(Args...))
 
class_ & def_buffer (Return(Class::*func)(Args...) const)
 
class_ & def_readwrite (const char *name, D C::*pm, const Extra &... extra)
 
class_ & def_readonly (const char *name, const D C::*pm, const Extra &...extra)
 
class_ & def_readwrite_static (const char *name, D *pm, const Extra &...extra)
 
class_ & def_readonly_static (const char *name, const D *pm, const Extra &...extra)
 
class_ & def_property_readonly (const char *name, const Getter &fget, const Extra &...extra)
 Uses return_value_policy::reference_internal by default.
 
class_ & def_property_readonly (const char *name, const cpp_function &fget, const Extra &...extra)
 Uses cpp_function's return_value_policy by default.
 
class_ & def_property_readonly_static (const char *name, const Getter &fget, const Extra &...extra)
 Uses return_value_policy::reference by default.
 
class_ & def_property_readonly_static (const char *name, const cpp_function &fget, const Extra &...extra)
 Uses cpp_function's return_value_policy by default.
 
class_ & def_property (const char *name, const Getter &fget, const Setter &fset, const Extra &...extra)
 Uses return_value_policy::reference_internal by default.
 
class_ & def_property (const char *name, const Getter &fget, const cpp_function &fset, const Extra &...extra)
 
class_ & def_property (const char *name, const cpp_function &fget, const cpp_function &fset, const Extra &...extra)
 Uses cpp_function's return_value_policy by default.
 
class_ & def_property_static (const char *name, const Getter &fget, const cpp_function &fset, const Extra &...extra)
 Uses return_value_policy::reference by default.
 
class_ & def_property_static (const char *name, const cpp_function &fget, const cpp_function &fset, const Extra &...extra)
 Uses cpp_function's return_value_policy by default.
 
- Public Member Functions inherited from pybind11::detail::generic_type
 __attribute__ ((deprecated("Use reinterpret_borrow<""generic_type"">() or reinterpret_steal<""generic_type"">()"))) generic_type(handle h
 
- Public Member Functions inherited from pybind11::object
 __attribute__ ((deprecated("Use reinterpret_borrow<object>() or reinterpret_steal<object>()"))) object(handle h
 
 object (const object &o)
 Copy constructor; always increases the reference count.
 
 object (object &&other) noexcept
 Move constructor; steals the object from other and preserves its reference count.
 
 ~object ()
 Destructor; automatically calls handle::dec_ref()
 
handle release ()
 
object & operator= (const object &other)
 
object & operator= (object &&other) noexcept
 
template<typename T >
T cast () const &
 
template<typename T >
T cast () &&
 
 object (handle h, borrowed_t)
 
 object (handle h, stolen_t)
 
template<typename T >
T cast () const &
 
template<typename T >
T cast () &&
 
template<>
void cast () const &
 
template<>
void cast () &&
 
- Public Member Functions inherited from pybind11::handle
 handle ()=default
 The default constructor creates a handle with a nullptr-valued pointer.
 
 handle (PyObject *ptr)
 Creates a handle from the given raw Python object pointer.
 
PyObject * ptr () const
 Return the underlying PyObject * pointer.
 
PyObject *& ptr ()
 
const handle & inc_ref () const &
 
const handle & dec_ref () const &
 
template<typename T >
T cast () const
 
 operator bool () const
 Return true when the handle wraps a valid Python object.
 
 __attribute__ ((deprecated("Use obj1.is(obj2) instead"))) bool operator
 
template<>
void cast () const
 
- Public Member Functions inherited from pybind11::detail::object_api< handle >
iterator begin () const
 
iterator end () const
 Return a sentinel which ends iteration.
 
item_accessor operator[] (handle key) const
 
item_accessor operator[] (const char *key) const
 See above (the only difference is that they key is provided as a string literal)
 
obj_attr_accessor attr (handle key) const
 
str_attr_accessor attr (const char *key) const
 See above (the only difference is that they key is provided as a string literal)
 
args_proxy operator* () const
 
object operator* (object_api const &other) const
 
bool contains (T &&item) const
 Check if the given item is contained within this object, i.e. item in obj.
 
object operator() (Args &&...args) const
 
 __attribute__ ((deprecated("call(...) was deprecated in favor of operator()(...)"))) object call(Args &&... args) const
 
bool is (object_api const &other) const
 Equivalent to obj is other in Python.
 
bool is_none () const
 Equivalent to obj is None in Python.
 
bool equal (object_api const &other) const
 Equivalent to obj == other in Python.
 
bool not_equal (object_api const &other) const
 
bool operator< (object_api const &other) const
 
bool operator<= (object_api const &other) const
 
bool operator> (object_api const &other) const
 
bool operator>= (object_api const &other) const
 
object operator- () const
 
object operator- (object_api const &other) const
 
object operator~ () const
 
object operator+ (object_api const &other) const
 
object operator+= (object_api const &other) const
 
object operator-= (object_api const &other) const
 
object operator*= (object_api const &other) const
 
object operator/ (object_api const &other) const
 
object operator/= (object_api const &other) const
 
object operator| (object_api const &other) const
 
object operator|= (object_api const &other) const
 
object operator& (object_api const &other) const
 
object operator&= (object_api const &other) const
 
object operator^ (object_api const &other) const
 
object operator^= (object_api const &other) const
 
object operator<< (object_api const &other) const
 
object operator<<= (object_api const &other) const
 
object operator>> (object_api const &other) const
 
object operator>>= (object_api const &other) const
 
__attribute__((deprecated("Use py::str(obj) instead"))) pybind11 str_attr_accessor doc () const
 Get or set the object's docstring, i.e. obj.__doc__.
 
int ref_count () const
 Return the object's current reference count.
 
handle get_type () const
 

Additional Inherited Members

- Public Attributes inherited from pybind11::class_< Type >
bool is_borrowed
 
bool borrowed_t
 
bool int
 
- Public Attributes inherited from pybind11::detail::generic_type
bool is_borrowed: object (is_borrowed ? object (h
 
- Public Attributes inherited from pybind11::object
bool is_borrowed: handle(h) { if (is_borrowed) inc_ref()
 
- Static Public Attributes inherited from pybind11::class_< Type >
static constexpr bool has_alias
 

Detailed Description

template<typename Type>
class pybind11::enum_< Type >

Binds C++ enumerations and enumeration classes to Python.

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