HepMC3 event record library
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes
enum_< Type > Class Template Reference

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

#include <pybind11.h>

+ Inheritance diagram for enum_< Type >:
+ Collaboration diagram for enum_< Type >:

Public Types

using Base = class_< Type >
 
using Scalar = typename std::underlying_type< Type >::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. More...
 
enum_value (char const *name, Type value, const char *doc=nullptr)
 Add an enumeration entry. More...
 
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. More...
 
class_def_property_readonly (const char *name, const cpp_function &fget, const Extra &...extra)
 Uses cpp_function's return_value_policy by default. More...
 
class_def_property_readonly_static (const char *name, const Getter &fget, const Extra &...extra)
 Uses return_value_policy::reference by default. More...
 
class_def_property_readonly_static (const char *name, const cpp_function &fget, const Extra &...extra)
 Uses cpp_function's return_value_policy by default. More...
 
class_def_property (const char *name, const Getter &fget, const Setter &fset, const Extra &...extra)
 Uses return_value_policy::reference_internal by default. More...
 
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. More...
 
class_def_property_static (const char *name, const Getter &fget, const cpp_function &fset, const Extra &...extra)
 Uses return_value_policy::reference by default. More...
 
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. More...
 

Static Public Member Functions

static void add_base (detail::type_record &rec)
 
static void add_base (detail::type_record &)
 

Static Public Attributes

static constexpr bool has_alias
 

Private Attributes

detail::enum_base m_base
 

Detailed Description

template<typename Type>
class enum_< Type >

Binds C++ enumerations and enumeration classes to Python.

Definition at line 1712 of file pybind11.h.

Member Function Documentation

class_& def_property ( const char *  name,
const Getter &  fget,
const Setter &  fset,
const Extra &...  extra 
)
inlineinherited

Uses return_value_policy::reference_internal by default.

Definition at line 1399 of file pybind11.h.

class_& def_property ( const char *  name,
const cpp_function fget,
const cpp_function fset,
const Extra &...  extra 
)
inlineinherited

Uses cpp_function's return_value_policy by default.

Definition at line 1410 of file pybind11.h.

class_& def_property_readonly ( const char *  name,
const Getter &  fget,
const Extra &...  extra 
)
inlineinherited

Uses return_value_policy::reference_internal by default.

Definition at line 1374 of file pybind11.h.

class_& def_property_readonly ( const char *  name,
const cpp_function fget,
const Extra &...  extra 
)
inlineinherited

Uses cpp_function's return_value_policy by default.

Definition at line 1381 of file pybind11.h.

class_& def_property_readonly_static ( const char *  name,
const Getter &  fget,
const Extra &...  extra 
)
inlineinherited

Uses return_value_policy::reference by default.

Definition at line 1387 of file pybind11.h.

class_& def_property_readonly_static ( const char *  name,
const cpp_function fget,
const Extra &...  extra 
)
inlineinherited

Uses cpp_function's return_value_policy by default.

Definition at line 1393 of file pybind11.h.

class_& def_property_static ( const char *  name,
const Getter &  fget,
const cpp_function fset,
const Extra &...  extra 
)
inlineinherited

Uses return_value_policy::reference by default.

Definition at line 1416 of file pybind11.h.

class_& def_property_static ( const char *  name,
const cpp_function fget,
const cpp_function fset,
const Extra &...  extra 
)
inlineinherited

Uses cpp_function's return_value_policy by default.

Definition at line 1422 of file pybind11.h.

enum_& export_values ( )
inline

Export enumeration entries into the parent scope.

Definition at line 1746 of file pybind11.h.

References enum_< Type >::export_values().

enum_& value ( char const *  name,
Type  value,
const char *  doc = nullptr 
)
inline

Add an enumeration entry.

Definition at line 1752 of file pybind11.h.

References enum_< Type >::value().


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