A base implementation with non-template methods. More...

#include <class.h>

Inheritance diagram for ug::bridge::ExportedClassBaseImpl:

Classes
struct	ConstructorOverload

Public Member Functions
virtual bool	construct_as_smart_pointer () const
	returns whether the class shall be wrapped in a SmartPtr on construction

virtual void	destroy (void *obj) const
	destructur for object

	ExportedClassBaseImpl (const std::string &tooltip)

virtual const ExportedMethodGroup *	get_const_exported_method_group (const std::string &name) const

virtual const ExportedMethod &	get_const_method (size_t i) const
	returns the first overload of an exported const function

virtual const ExportedMethodGroup &	get_const_method_group (size_t ind) const
	returns the i-th method group (all overloads of the i-th function)

virtual const ExportedMethod &	get_const_overload (size_t funcInd, size_t oInd) const
	returns the i-th overload of a const method

virtual const ExportedConstructor &	get_constructor (size_t i) const
	get exported constructor

virtual const ExportedMethodGroup *	get_exported_method_group (const std::string &name) const

virtual const boost::optional< ExportedConstructor & >	get_json_constructor () const
	get constructor for construction from json

virtual const ExportedMethod &	get_method (size_t i) const
	returns the first overload of an exported function

virtual const ExportedMethodGroup &	get_method_group (size_t ind) const
	returns the i-th method group (all overloads of the i-th function)

virtual const ExportedMethod &	get_overload (size_t funcInd, size_t oInd) const
	returns the i-th overload of a method

virtual bool	is_instantiable () const
	is instantiable

virtual size_t	num_const_methods () const
	number of registered const-methods (overloads are not counted)

virtual size_t	num_const_overloads (size_t funcInd) const
	returns the number of overloads of a const method

virtual size_t	num_constructors () const
	number of registered constructors

virtual size_t	num_methods () const
	number of registered methods (overloads are not counted)

virtual size_t	num_overloads (size_t funcInd) const
	returns the number of overloads of a method

virtual void	set_construct_as_smart_pointer (bool enable)
	sets whether the class shall be wrapped in a SmartPtr

virtual const std::string &	tooltip () const
	tooltip

virtual	~ExportedClassBaseImpl ()
	destructor

Public Member Functions inherited from ug::bridge::IExportedClass
virtual bool	check_consistency () const
	returns false is consistency-check failed

virtual const ClassNameNode &	class_name_node () const =0
	name node of class

virtual const std::vector< const char * > *	class_names () const =0
	name-list of class hierarchy

virtual DeleteFunction	get_delete_function () const =0
	returns a function which will call delete on the object

virtual const std::string &	group () const =0
	get groups

virtual bool	is_json_constructible () const =0
	get constructor for construction from json

virtual const std::string &	name () const =0
	name of class

virtual	~IExportedClass ()
	virtual destructor

Protected Types
typedef void(*	DestructorFunc) (void *)

Protected Member Functions
bool	constmethodname_registered (const std::string &name)
	returns true if methodname is already used by a method in this class

bool	constructor_type_id_registered (size_t typeID)
	returns if a constructor overload is registered

ExportedMethodGroup *	get_const_exported_method_group (const std::string &name)

ExportedMethodGroup *	get_exported_method_group (const std::string &name)

bool	methodname_registered (const std::string &name)
	returns true if methodname is already used by a method in this class

Protected Attributes
bool	m_constructAsSmartPtr

DestructorFunc	m_destructor

std::string	m_tooltip

std::vector< ExportedMethodGroup * >	m_vConstMethod

std::vector< ConstructorOverload >	m_vConstructor

std::vector< ExportedMethodGroup * >	m_vMethod

Private Member Functions
	ExportedClassBaseImpl ()

	ExportedClassBaseImpl (const ExportedClassBaseImpl &other)

Additional Inherited Members
Public Types inherited from ug::bridge::IExportedClass
typedef void(*	DeleteFunction) (const void *)

Detailed Description

A base implementation with non-template methods.

Speeds up compilation times.

Member Typedef Documentation

◆ DestructorFunc

typedef void(* ug::bridge::ExportedClassBaseImpl::DestructorFunc) (void *)

protected

Constructor & Destructor Documentation

◆ ExportedClassBaseImpl() [1/3]

ug::bridge::ExportedClassBaseImpl::ExportedClassBaseImpl ( )

private

◆ ExportedClassBaseImpl() [2/3]

ug::bridge::ExportedClassBaseImpl::ExportedClassBaseImpl ( const ExportedClassBaseImpl & other )

private

◆ ExportedClassBaseImpl() [3/3]

ug::bridge::ExportedClassBaseImpl::ExportedClassBaseImpl ( const std::string & tooltip )

◆ ~ExportedClassBaseImpl()

ug::bridge::ExportedClassBaseImpl::~ExportedClassBaseImpl ( )

virtual

destructor

References m_vConstMethod, m_vConstructor, and m_vMethod.

Member Function Documentation

◆ constmethodname_registered()

bool ug::bridge::ExportedClassBaseImpl::constmethodname_registered ( const std::string & name )

protected

returns true if methodname is already used by a method in this class

References m_vConstMethod, and ug::bridge::IExportedClass::name().

◆ construct_as_smart_pointer()

bool ug::bridge::ExportedClassBaseImpl::construct_as_smart_pointer ( ) const

virtual

returns whether the class shall be wrapped in a SmartPtr on construction

Implements ug::bridge::IExportedClass.

References m_constructAsSmartPtr.

◆ constructor_type_id_registered()

bool ug::bridge::ExportedClassBaseImpl::constructor_type_id_registered ( size_t typeID )

protected

returns if a constructor overload is registered

References m_vConstructor.

Referenced by ug::bridge::ExportedClass< TClass >::add_constructor().

◆ destroy()

void ug::bridge::ExportedClassBaseImpl::destroy ( void * obj ) const

virtual

destructur for object

Implements ug::bridge::IExportedClass.

References m_destructor.

◆ get_const_exported_method_group() [1/2]

ExportedMethodGroup * ug::bridge::ExportedClassBaseImpl::get_const_exported_method_group ( const std::string & name )

protected

References m_vConstMethod, and ug::bridge::IExportedClass::name().

◆ get_const_exported_method_group() [2/2]

const ExportedMethodGroup * ug::bridge::ExportedClassBaseImpl::get_const_exported_method_group ( const std::string & name ) const

virtual

Implements ug::bridge::IExportedClass.

References m_vConstMethod, and ug::bridge::IExportedClass::name().

Referenced by ug::bridge::ExportedClass< TClass >::add_method().

◆ get_const_method()

const ExportedMethod & ug::bridge::ExportedClassBaseImpl::get_const_method ( size_t i ) const

virtual

returns the first overload of an exported const function

Implements ug::bridge::IExportedClass.

References m_vConstMethod.

◆ get_const_method_group()

const ExportedMethodGroup & ug::bridge::ExportedClassBaseImpl::get_const_method_group ( size_t ind ) const

virtual

returns the i-th method group (all overloads of the i-th function)

Implements ug::bridge::IExportedClass.

References m_vConstMethod.

◆ get_const_overload()

const ExportedMethod & ug::bridge::ExportedClassBaseImpl::get_const_overload	(	size_t	funcInd,
		size_t	oInd
	)		const

virtual

returns the i-th overload of a const method

Implements ug::bridge::IExportedClass.

References m_vConstMethod.

◆ get_constructor()

const ExportedConstructor & ug::bridge::ExportedClassBaseImpl::get_constructor ( size_t i ) const

virtual

get exported constructor

Implements ug::bridge::IExportedClass.

References m_vConstructor.

◆ get_exported_method_group() [1/2]

ExportedMethodGroup * ug::bridge::ExportedClassBaseImpl::get_exported_method_group ( const std::string & name )

protected

References m_vMethod, and ug::bridge::IExportedClass::name().

◆ get_exported_method_group() [2/2]

const ExportedMethodGroup * ug::bridge::ExportedClassBaseImpl::get_exported_method_group ( const std::string & name ) const

virtual

Implements ug::bridge::IExportedClass.

References m_vMethod, and ug::bridge::IExportedClass::name().

Referenced by ug::bridge::ExportedClass< TClass >::add_method().

◆ get_json_constructor()

const boost::optional< ExportedConstructor & > ug::bridge::ExportedClassBaseImpl::get_json_constructor ( ) const

virtual

get constructor for construction from json

Implements ug::bridge::IExportedClass.

References ug::GetUniqueTypeID(), ug::bridge::IExportedClass::is_json_constructible(), and m_vConstructor.

◆ get_method()

const ExportedMethod & ug::bridge::ExportedClassBaseImpl::get_method ( size_t i ) const

virtual

returns the first overload of an exported function

Implements ug::bridge::IExportedClass.

References m_vMethod.

◆ get_method_group()

const ExportedMethodGroup & ug::bridge::ExportedClassBaseImpl::get_method_group ( size_t ind ) const

virtual

returns the i-th method group (all overloads of the i-th function)

Implements ug::bridge::IExportedClass.

References m_vMethod.

◆ get_overload()

const ExportedMethod & ug::bridge::ExportedClassBaseImpl::get_overload	(	size_t	funcInd,
		size_t	oInd
	)		const

virtual

returns the i-th overload of a method

Implements ug::bridge::IExportedClass.

References m_vMethod.

◆ is_instantiable()

bool ug::bridge::ExportedClassBaseImpl::is_instantiable ( ) const

virtual

is instantiable

Implements ug::bridge::IExportedClass.

References m_vConstructor.

◆ methodname_registered()

bool ug::bridge::ExportedClassBaseImpl::methodname_registered ( const std::string & name )

protected

returns true if methodname is already used by a method in this class

References m_vMethod, and ug::bridge::IExportedClass::name().

◆ num_const_methods()

size_t ug::bridge::ExportedClassBaseImpl::num_const_methods ( ) const

virtual

number of registered const-methods (overloads are not counted)

Implements ug::bridge::IExportedClass.

References m_vConstMethod.

◆ num_const_overloads()

size_t ug::bridge::ExportedClassBaseImpl::num_const_overloads ( size_t funcInd ) const

virtual

returns the number of overloads of a const method

Implements ug::bridge::IExportedClass.

References m_vConstMethod.

◆ num_constructors()

size_t ug::bridge::ExportedClassBaseImpl::num_constructors ( ) const

virtual

number of registered constructors

Implements ug::bridge::IExportedClass.

References m_vConstructor.

◆ num_methods()

size_t ug::bridge::ExportedClassBaseImpl::num_methods ( ) const

virtual

number of registered methods (overloads are not counted)

Implements ug::bridge::IExportedClass.

References m_vMethod.

◆ num_overloads()

size_t ug::bridge::ExportedClassBaseImpl::num_overloads ( size_t funcInd ) const

virtual

returns the number of overloads of a method

Implements ug::bridge::IExportedClass.

References m_vMethod.

◆ set_construct_as_smart_pointer()

void ug::bridge::ExportedClassBaseImpl::set_construct_as_smart_pointer ( bool enable )

virtual

sets whether the class shall be wrapped in a SmartPtr

Returns a reference to this, so that it can be used in a chained call.

References m_constructAsSmartPtr.

◆ tooltip()

const std::string & ug::bridge::ExportedClassBaseImpl::tooltip ( ) const

virtual

tooltip

Implements ug::bridge::IExportedClass.

References m_tooltip.

Referenced by ug::bridge::ExportedClass< TClass >::add_constructor(), and ug::bridge::ExportedClass< TClass >::add_method().

Member Data Documentation

◆ m_constructAsSmartPtr

bool ug::bridge::ExportedClassBaseImpl::m_constructAsSmartPtr

protected

Referenced by construct_as_smart_pointer(), and set_construct_as_smart_pointer().

◆ m_destructor

DestructorFunc ug::bridge::ExportedClassBaseImpl::m_destructor

protected

Referenced by ug::bridge::ExportedClass< TClass >::add_constructor(), and destroy().

◆ m_tooltip

std::string ug::bridge::ExportedClassBaseImpl::m_tooltip

protected

Referenced by tooltip().

◆ m_vConstMethod

std::vector<ExportedMethodGroup*> ug::bridge::ExportedClassBaseImpl::m_vConstMethod

protected

Referenced by ug::bridge::ExportedClass< TClass >::add_method(), constmethodname_registered(), get_const_exported_method_group(), get_const_exported_method_group(), get_const_method(), get_const_method_group(), get_const_overload(), num_const_methods(), num_const_overloads(), and ~ExportedClassBaseImpl().

◆ m_vConstructor

std::vector<ConstructorOverload> ug::bridge::ExportedClassBaseImpl::m_vConstructor

protected

Referenced by ug::bridge::ExportedClass< TClass >::add_constructor(), constructor_type_id_registered(), get_constructor(), get_json_constructor(), is_instantiable(), num_constructors(), and ~ExportedClassBaseImpl().

◆ m_vMethod

std::vector<ExportedMethodGroup*> ug::bridge::ExportedClassBaseImpl::m_vMethod

protected

Referenced by ug::bridge::ExportedClass< TClass >::add_method(), get_exported_method_group(), get_exported_method_group(), get_method(), get_method_group(), get_overload(), methodname_registered(), num_methods(), num_overloads(), and ~ExportedClassBaseImpl().

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

ugbase/registry/class.h
ugbase/registry/class.cpp

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DestructorFunc

Constructor & Destructor Documentation

◆ ExportedClassBaseImpl() [1/3]

◆ ExportedClassBaseImpl() [2/3]

◆ ExportedClassBaseImpl() [3/3]

◆ ~ExportedClassBaseImpl()

Member Function Documentation

◆ constmethodname_registered()

◆ construct_as_smart_pointer()

◆ constructor_type_id_registered()

◆ destroy()

◆ get_const_exported_method_group() [1/2]

◆ get_const_exported_method_group() [2/2]

◆ get_const_method()

◆ get_const_method_group()

◆ get_const_overload()

◆ get_constructor()

◆ get_exported_method_group() [1/2]

◆ get_exported_method_group() [2/2]

◆ get_json_constructor()

◆ get_method()

◆ get_method_group()

◆ get_overload()

◆ is_instantiable()

◆ methodname_registered()

◆ num_const_methods()

◆ num_const_overloads()

◆ num_constructors()

◆ num_methods()

◆ num_overloads()

◆ set_construct_as_smart_pointer()

◆ tooltip()

Member Data Documentation

◆ m_constructAsSmartPtr

◆ m_destructor

◆ m_tooltip

◆ m_vConstMethod

◆ m_vConstructor

◆ m_vMethod