#include <pybind11.h>

Inheritance diagram for class_< type_, options >:

Classes
struct	is_valid_class_option

Public Types
using	holder_type = detail::exactly_one_t< is_holder, std::unique_ptr< type >, options... >

using	type = type_

using	type_alias = detail::exactly_one_t< is_subtype, void, options... >

Public Member Functions
template<typename... Extra>
	class_ (handle scope, const char *name, const Extra &...extra)

template<typename Func , typename... Extra>
class_ &	def (const char *name_, Func &&f, const Extra &...extra)

template<typename... Args, typename... Extra>
class_ &	def (const detail::initimpl::alias_constructor< Args... > &init, const Extra &...extra)

template<typename... Args, typename... Extra>
class_ &	def (const detail::initimpl::constructor< Args... > &init, const Extra &...extra)

template<typename T , typename... Extra, detail::enable_if_t< T::op_enable_if_hook, int > = 0>
class_ &	def (const T &op, const Extra &...extra)

template<typename... Args, typename... Extra>
class_ &	def (detail::initimpl::factory< Args... > &&init, const Extra &...extra)

template<typename... Args, typename... Extra>
class_ &	def (detail::initimpl::pickle_factory< Args... > &&pf, const Extra &...extra)

template<typename Func >
class_ &	def_buffer (Func &&func)

template<typename Return , typename Class , typename... Args>
class_ &	def_buffer (Return(Class::*func)(Args...) const)

template<typename Return , typename Class , typename... Args>
class_ &	def_buffer (Return(Class::*func)(Args...))

template<typename T , typename... Extra, detail::enable_if_t< T::op_enable_if_hook, int > = 0>
class_ &	def_cast (const T &op, const Extra &...extra)

template<typename... 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...

template<typename Getter , typename... Extra>
class_ &	def_property (const char *name, const Getter &fget, const cpp_function &fset, const Extra &...extra)

template<typename Getter , typename Setter , typename... Extra>
class_ &	def_property (const char *name, const Getter &fget, const Setter &fset, const Extra &...extra)
	Uses return_value_policy::reference_internal by default. More...

template<typename... Extra>
class_ &	def_property_readonly (const char *name, const cpp_function &fget, const Extra &...extra)
	Uses cpp_function's return_value_policy by default. More...

template<typename Getter , typename... Extra>
class_ &	def_property_readonly (const char *name, const Getter &fget, const Extra &...extra)
	Uses return_value_policy::reference_internal by default. More...

template<typename... Extra>
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...

template<typename Getter , typename... Extra>
class_ &	def_property_readonly_static (const char *name, const Getter &fget, const Extra &...extra)
	Uses return_value_policy::reference by default. More...

template<typename... Extra>
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...

template<typename Getter , typename... Extra>
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...

template<typename C , typename D , typename... Extra>
class_ &	def_readonly (const char name, const D C::pm, const Extra &...extra)

template<typename D , typename... Extra>
class_ &	def_readonly_static (const char name, const D pm, const Extra &...extra)

template<typename C , typename D , typename... Extra>
class_ &	def_readwrite (const char name, D C::pm, const Extra &...extra)

template<typename D , typename... Extra>
class_ &	def_readwrite_static (const char name, D pm, const Extra &...extra)

template<typename Func , typename... Extra>
class_ &	def_static (const char *name_, Func &&f, const Extra &...extra)

Static Public Member Functions
template<typename Base , detail::enable_if_t<!is_base< Base >::value, int > = 0>
static void	add_base (detail::type_record &)

template<typename Base , detail::enable_if_t< is_base< Base >::value, int > = 0>
static void	add_base (detail::type_record &rec)

Static Public Attributes
constexpr static bool	has_alias = !std::is_void<type_alias>::value

Private Types
template<typename T >
using	is_base = detail::is_strict_base_of< T, type_ >

template<typename T >
using	is_holder = detail::is_holder_type< type_, T >

template<typename T >
using	is_subtype = detail::is_strict_base_of< type_, T >

Static Private Member Functions
static void	dealloc (detail::value_and_holder &v_h)
	Deallocates an instance; via holder, if constructed; otherwise via operator delete. More...

static detail::function_record *	get_function_record (handle h)

template<typename T >
static void	init_holder (detail::instance inst, detail::value_and_holder &v_h, const holder_type , const std::enable_shared_from_this< T > *)
	Initialize holder object, variant 1: object derives from enable_shared_from_this. More...

static void	init_holder (detail::instance inst, detail::value_and_holder &v_h, const holder_type holder_ptr, const void *)

static void	init_holder_from_existing (const detail::value_and_holder &v_h, const holder_type *holder_ptr, std::false_type)

static void	init_holder_from_existing (const detail::value_and_holder &v_h, const holder_type *holder_ptr, std::true_type)

static void	init_instance (detail::instance inst, const void holder_ptr)

Detailed Description

template<typename type_, typename... options>
class class_< type_, options >

Definition at line 1539 of file pybind11.h.

Member Typedef Documentation

◆ holder_type

template<typename type_ , typename... options>

using class_< type_, options >::holder_type = detail::exactly_one_t<is_holder, std::unique_ptr<type>, options...>

Definition at line 1554 of file pybind11.h.

◆ is_base

template<typename type_ , typename... options>

template<typename T >

using class_< type_, options >::is_base = detail::is_strict_base_of<T, type_>

private

Definition at line 1545 of file pybind11.h.

◆ is_holder

template<typename type_ , typename... options>

template<typename T >

using class_< type_, options >::is_holder = detail::is_holder_type<type_, T>

private

Definition at line 1541 of file pybind11.h.

◆ is_subtype

template<typename type_ , typename... options>

template<typename T >

using class_< type_, options >::is_subtype = detail::is_strict_base_of<type_, T>

private

Definition at line 1543 of file pybind11.h.

◆ type

template<typename type_ , typename... options>

using class_< type_, options >::type = type_

Definition at line 1551 of file pybind11.h.

◆ type_alias

template<typename type_ , typename... options>

using class_< type_, options >::type_alias = detail::exactly_one_t<is_subtype, void, options...>

Definition at line 1552 of file pybind11.h.

Constructor & Destructor Documentation

◆ class_()

template<typename type_ , typename... options>

template<typename... Extra>

class_< type_, options >::class_	(	handle	scope,
		const char *	name,
		const Extra &...	extra
	)

inline

Definition at line 1565 of file pybind11.h.

Member Function Documentation

◆ add_base() [1/2]

template<typename type_ , typename... options>

template<typename Base , detail::enable_if_t<!is_base< Base >::value, int > = 0>

static void class_< type_, options >::add_base ( detail::type_record & )

inlinestatic

Definition at line 1617 of file pybind11.h.

◆ add_base() [2/2]

template<typename type_ , typename... options>

template<typename Base , detail::enable_if_t< is_base< Base >::value, int > = 0>

static void class_< type_, options >::add_base ( detail::type_record & rec )

inlinestatic

Definition at line 1610 of file pybind11.h.

◆ dealloc()

template<typename type_ , typename... options>

static void class_< type_, options >::dealloc ( detail::value_and_holder & v_h )

inlinestaticprivate

Deallocates an instance; via holder, if constructed; otherwise via operator delete.

Definition at line 1917 of file pybind11.h.

◆ def() [1/6]

template<typename type_ , typename... options>

template<typename Func , typename... Extra>

class_& class_< type_, options >::def	(	const char *	name_,
		Func &&	f,
		const Extra &...	extra
	)

inline

Definition at line 1620 of file pybind11.h.

◆ def() [2/6]

template<typename type_ , typename... options>

template<typename... Args, typename... Extra>

class_& class_< type_, options >::def	(	const detail::initimpl::alias_constructor< Args... > &	init,
		const Extra &...	extra
	)

inline

Definition at line 1664 of file pybind11.h.

◆ def() [3/6]

template<typename type_ , typename... options>

template<typename... Args, typename... Extra>

class_& class_< type_, options >::def	(	const detail::initimpl::constructor< Args... > &	init,
		const Extra &...	extra
	)

inline

Definition at line 1657 of file pybind11.h.

◆ def() [4/6]

template<typename type_ , typename... options>

template<typename T , typename... Extra, detail::enable_if_t< T::op_enable_if_hook, int > = 0>

class_& class_< type_, options >::def	(	const T &	op,
		const Extra &...	extra
	)

inline

Definition at line 1645 of file pybind11.h.

◆ def() [5/6]

template<typename type_ , typename... options>

template<typename... Args, typename... Extra>

class_& class_< type_, options >::def	(	detail::initimpl::factory< Args... > &&	init,
		const Extra &...	extra
	)

inline

Definition at line 1671 of file pybind11.h.

◆ def() [6/6]

template<typename type_ , typename... options>

template<typename... Args, typename... Extra>

class_& class_< type_, options >::def	(	detail::initimpl::pickle_factory< Args... > &&	pf,
		const Extra &...	extra
	)

inline

Definition at line 1677 of file pybind11.h.

◆ def_buffer() [1/3]

template<typename type_ , typename... options>

template<typename Func >

class_& class_< type_, options >::def_buffer ( Func && func )

inline

Definition at line 1683 of file pybind11.h.

◆ def_buffer() [2/3]

template<typename type_ , typename... options>

template<typename Return , typename Class , typename... Args>

class_& class_< type_, options >::def_buffer ( Return(Class::*)(Args...) const func )

inline

Definition at line 1711 of file pybind11.h.

◆ def_buffer() [3/3]

template<typename type_ , typename... options>

template<typename Return , typename Class , typename... Args>

class_& class_< type_, options >::def_buffer ( Return(Class::*)(Args...) func )

inline

Definition at line 1706 of file pybind11.h.

◆ def_cast()

template<typename type_ , typename... options>

template<typename T , typename... Extra, detail::enable_if_t< T::op_enable_if_hook, int > = 0>

class_& class_< type_, options >::def_cast	(	const T &	op,
		const Extra &...	extra
	)

inline

Definition at line 1651 of file pybind11.h.

◆ def_property() [1/3]

template<typename type_ , typename... options>

template<typename... Extra>

class_& class_< type_, options >::def_property	(	const char *	name,
		const cpp_function &	fget,
		const cpp_function &	fset,
		const Extra &...	extra
	)

inline

Uses cpp_function's return_value_policy by default.

Definition at line 1802 of file pybind11.h.

◆ def_property() [2/3]

template<typename type_ , typename... options>

template<typename Getter , typename... Extra>

class_& class_< type_, options >::def_property	(	const char *	name,
		const Getter &	fget,
		const cpp_function &	fset,
		const Extra &...	extra
	)

inline

Definition at line 1789 of file pybind11.h.

◆ def_property() [3/3]

template<typename type_ , typename... options>

template<typename Getter , typename Setter , typename... Extra>

class_& class_< type_, options >::def_property	(	const char *	name,
		const Getter &	fget,
		const Setter &	fset,
		const Extra &...	extra
	)

inline

Uses return_value_policy::reference_internal by default.

Definition at line 1784 of file pybind11.h.

◆ def_property_readonly() [1/2]

template<typename type_ , typename... options>

template<typename... Extra>

class_& class_< type_, options >::def_property_readonly	(	const char *	name,
		const cpp_function &	fget,
		const Extra &...	extra
	)

inline

Uses cpp_function's return_value_policy by default.

Definition at line 1761 of file pybind11.h.

◆ def_property_readonly() [2/2]

template<typename type_ , typename... options>

template<typename Getter , typename... Extra>

class_& class_< type_, options >::def_property_readonly	(	const char *	name,
		const Getter &	fget,
		const Extra &...	extra
	)

inline

Uses return_value_policy::reference_internal by default.

Definition at line 1751 of file pybind11.h.

◆ def_property_readonly_static() [1/2]

template<typename type_ , typename... options>

template<typename... Extra>

class_& class_< type_, options >::def_property_readonly_static	(	const char *	name,
		const cpp_function &	fget,
		const Extra &...	extra
	)

inline

Uses cpp_function's return_value_policy by default.

Definition at line 1775 of file pybind11.h.

◆ def_property_readonly_static() [2/2]

template<typename type_ , typename... options>

template<typename Getter , typename... Extra>

class_& class_< type_, options >::def_property_readonly_static	(	const char *	name,
		const Getter &	fget,
		const Extra &...	extra
	)

inline

Uses return_value_policy::reference by default.

Definition at line 1768 of file pybind11.h.

◆ def_property_static() [1/2]

template<typename type_ , typename... options>

template<typename... Extra>

class_& class_< type_, options >::def_property_static	(	const char *	name,
		const cpp_function &	fget,
		const cpp_function &	fset,
		const Extra &...	extra
	)

inline

Uses cpp_function's return_value_policy by default.

Definition at line 1821 of file pybind11.h.

◆ def_property_static() [2/2]

template<typename type_ , typename... options>

template<typename Getter , typename... Extra>

class_& class_< type_, options >::def_property_static	(	const char *	name,
		const Getter &	fget,
		const cpp_function &	fset,
		const Extra &...	extra
	)

inline

Uses return_value_policy::reference by default.

Definition at line 1811 of file pybind11.h.

◆ def_readonly()

template<typename type_ , typename... options>

template<typename C , typename D , typename... Extra>

class_& class_< type_, options >::def_readonly	(	const char *	name,
		const D C::*	pm,
		const Extra &...	extra
	)

inline

Definition at line 1726 of file pybind11.h.

◆ def_readonly_static()

template<typename type_ , typename... options>

template<typename D , typename... Extra>

class_& class_< type_, options >::def_readonly_static	(	const char *	name,
		const D *	pm,
		const Extra &...	extra
	)

inline

Definition at line 1743 of file pybind11.h.

◆ def_readwrite()

template<typename type_ , typename... options>

template<typename C , typename D , typename... Extra>

class_& class_< type_, options >::def_readwrite	(	const char *	name,
		D C::*	pm,
		const Extra &...	extra
	)

inline

Definition at line 1716 of file pybind11.h.

◆ def_readwrite_static()

template<typename type_ , typename... options>

template<typename D , typename... Extra>

class_& class_< type_, options >::def_readwrite_static	(	const char *	name,
		D *	pm,
		const Extra &...	extra
	)

inline

Definition at line 1735 of file pybind11.h.

◆ def_static()

template<typename type_ , typename... options>

template<typename Func , typename... Extra>

class_& class_< type_, options >::def_static	(	const char *	name_,
		Func &&	f,
		const Extra &...	extra
	)

inline

Definition at line 1631 of file pybind11.h.

◆ get_function_record()

template<typename type_ , typename... options>

static detail::function_record* class_< type_, options >::get_function_record ( handle h )

inlinestaticprivate

Definition at line 1935 of file pybind11.h.

◆ init_holder() [1/2]

template<typename type_ , typename... options>

template<typename T >

static void class_< type_, options >::init_holder	(	detail::instance *	inst,
		detail::value_and_holder &	v_h,
		const holder_type *	,
		const std::enable_shared_from_this< T > *
	)

inlinestaticprivate

Initialize holder object, variant 1: object derives from enable_shared_from_this.

Definition at line 1856 of file pybind11.h.

◆ init_holder() [2/2]

template<typename type_ , typename... options>

static void class_< type_, options >::init_holder	(	detail::instance *	inst,
		detail::value_and_holder &	v_h,
		const holder_type *	holder_ptr,
		const void *
	)

inlinestaticprivate

Initialize holder object, variant 2: try to construct from existing holder object, if possible

Definition at line 1890 of file pybind11.h.

◆ init_holder_from_existing() [1/2]

template<typename type_ , typename... options>

static void class_< type_, options >::init_holder_from_existing	(	const detail::value_and_holder &	v_h,
		const holder_type *	holder_ptr,
		std::false_type
	)

inlinestaticprivate

Definition at line 1881 of file pybind11.h.

◆ init_holder_from_existing() [2/2]

template<typename type_ , typename... options>

static void class_< type_, options >::init_holder_from_existing	(	const detail::value_and_holder &	v_h,
		const holder_type *	holder_ptr,
		std::true_type
	)

inlinestaticprivate

Definition at line 1874 of file pybind11.h.

◆ init_instance()

template<typename type_ , typename... options>

static void class_< type_, options >::init_instance	(	detail::instance *	inst,
		const void *	holder_ptr
	)

inlinestaticprivate

Performs instance initialization including constructing a holder and registering the known instance. Should be called as soon as the type value_ptr is set for an instance. Takes an optional pointer to an existing holder to use; if not specified and the instance is .owned, a new holder will be constructed to manage the value pointer.

Definition at line 1907 of file pybind11.h.

Member Data Documentation

◆ has_alias

template<typename type_ , typename... options>

constexpr static bool class_< type_, options >::has_alias = !std::is_void<type_alias>::value

staticconstexpr

Definition at line 1553 of file pybind11.h.

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

pybind11.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Types

Static Private Member Functions

Detailed Description

template<typename type_, typename... options> class class_< type_, options >

Member Typedef Documentation

◆ holder_type

◆ is_base

◆ is_holder

◆ is_subtype

◆ type

◆ type_alias

Constructor & Destructor Documentation

◆ class_()

Member Function Documentation

◆ add_base() [1/2]

◆ add_base() [2/2]

◆ dealloc()

◆ def() [1/6]

◆ def() [2/6]

◆ def() [3/6]

◆ def() [4/6]

◆ def() [5/6]

◆ def() [6/6]

◆ def_buffer() [1/3]

◆ def_buffer() [2/3]

◆ def_buffer() [3/3]

◆ def_cast()

◆ def_property() [1/3]

◆ def_property() [2/3]

◆ def_property() [3/3]

◆ def_property_readonly() [1/2]

◆ def_property_readonly() [2/2]

◆ def_property_readonly_static() [1/2]

◆ def_property_readonly_static() [2/2]

◆ def_property_static() [1/2]

◆ def_property_static() [2/2]

◆ def_readonly()

◆ def_readonly_static()

◆ def_readwrite()

◆ def_readwrite_static()

◆ def_static()

◆ get_function_record()

◆ init_holder() [1/2]

◆ init_holder() [2/2]

◆ init_holder_from_existing() [1/2]

◆ init_holder_from_existing() [2/2]

◆ init_instance()

Member Data Documentation

◆ has_alias

template<typename type_, typename... options>
class class_< type_, options >