ScriptInterface::ObjectList< ManagedType, BaseType > Class Template Reference

Owning list of ObjectHandles. More...

#include <ObjectList.hpp>

Inheritance diagram for ScriptInterface::ObjectList< ManagedType, BaseType >:

Collaboration diagram for ScriptInterface::ObjectList< ManagedType, BaseType >:

Public Types
using	Base = ObjectContainer< ObjectList, ManagedType, BaseType >

Public Member Functions
	ObjectList ()
void	do_construct (VariantMap const &params) override
void	add (std::shared_ptr< ManagedType > const &element)
	Add an element to the list.
void	remove (std::shared_ptr< ManagedType > const &element)
	Removes all occurrences of an element from the list.
auto const &	elements () const
	List elements.
void	clear ()
	Clear the list.

Protected Member Functions
Variant	do_call_method (std::string const &method, VariantMap const &parameters) override

Private Member Functions
virtual void	add_in_core (const std::shared_ptr< ManagedType > &obj_ptr)=0
virtual void	remove_in_core (const std::shared_ptr< ManagedType > &obj_ptr)=0
virtual bool	has_in_core (const std::shared_ptr< ManagedType > &obj_ptr) const =0

Detailed Description

template<typename ManagedType, class BaseType = ObjectHandle>
class ScriptInterface::ObjectList< ManagedType, BaseType >

Owning list of ObjectHandles.

Template Parameters

ManagedType

Type of the managed objects, needs to be derived from ObjectHandle

Definition at line 44 of file ObjectList.hpp.

Member Typedef Documentation

Base

template<typename ManagedType , class BaseType = ObjectHandle>

using ScriptInterface::ObjectList< ManagedType, BaseType >::Base = ObjectContainer<ObjectList, ManagedType, BaseType>

Definition at line 46 of file ObjectList.hpp.

Constructor & Destructor Documentation

ObjectList()

template<typename ManagedType , class BaseType = ObjectHandle>

ScriptInterface::ObjectList< ManagedType, BaseType >::ObjectList ( )

inline

Definition at line 58 of file ObjectList.hpp.

References ScriptInterface::make_vector_of_variants(), and ScriptInterface::AutoParameter::read_only.

Member Function Documentation

add()

template<typename ManagedType , class BaseType = ObjectHandle>

void ScriptInterface::ObjectList< ManagedType, BaseType >::add ( std::shared_ptr< ManagedType > const &  element )

inline

Add an element to the list.

Parameters

element

The element to add.

Definition at line 77 of file ObjectList.hpp.

References ScriptInterface::ObjectList< ManagedType, BaseType >::add_in_core(), and ScriptInterface::ObjectList< ManagedType, BaseType >::has_in_core().

Referenced by ScriptInterface::ObjectList< ManagedType, BaseType >::do_call_method().

add_in_core()

template<typename ManagedType , class BaseType = ObjectHandle>

virtual void ScriptInterface::ObjectList< ManagedType, BaseType >::add_in_core ( const std::shared_ptr< ManagedType > &  obj_ptr )

privatepure virtual

Referenced by ScriptInterface::ObjectList< ManagedType, BaseType >::add(), and ScriptInterface::ObjectList< ManagedType, BaseType >::do_construct().

clear()

template<typename ManagedType , class BaseType = ObjectHandle>

void ScriptInterface::ObjectList< ManagedType, BaseType >::clear ( )

inline

Clear the list.

Definition at line 113 of file ObjectList.hpp.

References ScriptInterface::ObjectList< ManagedType, BaseType >::remove_in_core().

Referenced by ScriptInterface::ObjectList< ManagedType, BaseType >::do_call_method().

do_call_method()

template<typename ManagedType , class BaseType = ObjectHandle>

Variant ScriptInterface::ObjectList< ManagedType, BaseType >::do_call_method ( std::string const &  method, VariantMap const &  parameters  )

inlineoverrideprotected

Definition at line 122 of file ObjectList.hpp.

References ScriptInterface::ObjectList< ManagedType, BaseType >::add(), ScriptInterface::ObjectList< ManagedType, BaseType >::clear(), ScriptInterface::make_vector_of_variants(), ScriptInterface::none, and ScriptInterface::ObjectList< ManagedType, BaseType >::remove().

do_construct()

template<typename ManagedType , class BaseType = ObjectHandle>

void ScriptInterface::ObjectList< ManagedType, BaseType >::do_construct ( VariantMap const &  params )

inlineoverride

Definition at line 65 of file ObjectList.hpp.

References ScriptInterface::ObjectList< ManagedType, BaseType >::add_in_core(), and params.

elements()

template<typename ManagedType , class BaseType = ObjectHandle>

auto const & ScriptInterface::ObjectList< ManagedType, BaseType >::elements ( ) const

inline

List elements.

Definition at line 108 of file ObjectList.hpp.

has_in_core()

template<typename ManagedType , class BaseType = ObjectHandle>

virtual bool ScriptInterface::ObjectList< ManagedType, BaseType >::has_in_core ( const std::shared_ptr< ManagedType > &  obj_ptr ) const

privatepure virtual

Referenced by ScriptInterface::ObjectList< ManagedType, BaseType >::add(), and ScriptInterface::ObjectList< ManagedType, BaseType >::remove().

remove()

template<typename ManagedType , class BaseType = ObjectHandle>

void ScriptInterface::ObjectList< ManagedType, BaseType >::remove ( std::shared_ptr< ManagedType > const &  element )

inline

Removes all occurrences of an element from the list.

Parameters

element

The element to remove.

Definition at line 93 of file ObjectList.hpp.

References ScriptInterface::ObjectList< ManagedType, BaseType >::has_in_core(), and ScriptInterface::ObjectList< ManagedType, BaseType >::remove_in_core().

Referenced by ScriptInterface::ObjectList< ManagedType, BaseType >::do_call_method().

remove_in_core()

template<typename ManagedType , class BaseType = ObjectHandle>

virtual void ScriptInterface::ObjectList< ManagedType, BaseType >::remove_in_core ( const std::shared_ptr< ManagedType > &  obj_ptr )

privatepure virtual

Referenced by ScriptInterface::ObjectList< ManagedType, BaseType >::clear(), and ScriptInterface::ObjectList< ManagedType, BaseType >::remove().

---

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

• ObjectList.hpp