ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType > Class Template Reference

Owning map of ObjectHandles. More...

#include <ObjectMap.hpp>

Inheritance diagram for ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >:

Collaboration diagram for ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >:

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

Public Member Functions
	ObjectMap ()
void	do_construct (VariantMap const &params) override=0
void	insert (KeyType const &key, std::shared_ptr< ManagedType > const &element)
	Add an element to the map.
KeyType	insert (std::shared_ptr< ManagedType > const &element)
	Add an element to the map.
void	erase (KeyType const &key)
	Removes all occurrences of an element from the map.
auto const &	elements () const
	Map elements.
void	clear ()
	Clear the map.

Protected Member Functions
Variant	do_call_method (std::string const &method, VariantMap const &parameters) override
void	restore_from_checkpoint (VariantMap const &params)
KeyType	get_key (Variant const &key) const

Private Member Functions
virtual KeyType	insert_in_core (std::shared_ptr< ManagedType > const &obj_ptr)=0
virtual void	insert_in_core (KeyType const &key, std::shared_ptr< ManagedType > const &obj_ptr)=0
virtual void	erase_in_core (KeyType const &key)=0

Detailed Description

template<typename ManagedType, class BaseType = ObjectHandle, class KeyType = int>
class ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >

Owning map of ObjectHandles.

Template Parameters

ManagedType

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

Definition at line 43 of file ObjectMap.hpp.

Member Typedef Documentation

Base

template<typename ManagedType , class BaseType = ObjectHandle, class KeyType = int>

using ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::Base = ObjectContainer<ObjectMap, ManagedType, BaseType>

Definition at line 45 of file ObjectMap.hpp.

Constructor & Destructor Documentation

ObjectMap()

template<typename ManagedType , class BaseType = ObjectHandle, class KeyType = int>

ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::ObjectMap ( )

inline

Definition at line 58 of file ObjectMap.hpp.

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

Member Function Documentation

clear()

template<typename ManagedType , class BaseType = ObjectHandle, class KeyType = int>

void ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::clear ( )

inline

Clear the map.

Definition at line 108 of file ObjectMap.hpp.

References ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::erase_in_core().

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

do_call_method()

template<typename ManagedType , class BaseType = ObjectHandle, class KeyType = int>

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

inlineoverrideprotected

Definition at line 117 of file ObjectMap.hpp.

References ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::clear(), ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::erase(), ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::get_key(), ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::insert(), ScriptInterface::make_unordered_map_of_variants(), and ScriptInterface::none.

Referenced by ScriptInterface::Interactions::BondedInteractions::do_call_method().

do_construct()

template<typename ManagedType , class BaseType = ObjectHandle, class KeyType = int>

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

overridepure virtual

Implemented in ScriptInterface::BondBreakage::BreakageSpecs, and ScriptInterface::Interactions::BondedInteractions.

elements()

template<typename ManagedType , class BaseType = ObjectHandle, class KeyType = int>

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

inline

Map elements.

Definition at line 103 of file ObjectMap.hpp.

erase()

template<typename ManagedType , class BaseType = ObjectHandle, class KeyType = int>

void ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::erase ( KeyType const &  key )

inline

Removes all occurrences of an element from the map.

Parameters

key	Identifier of the element to remove.

Definition at line 95 of file ObjectMap.hpp.

References ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::erase_in_core().

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

erase_in_core()

template<typename ManagedType , class BaseType = ObjectHandle, class KeyType = int>

virtual void ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::erase_in_core ( KeyType const &  key )

privatepure virtual

Referenced by ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::clear(), and ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::erase().

get_key()

template<typename ManagedType , class BaseType = ObjectHandle, class KeyType = int>

KeyType ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::get_key ( Variant const &  key ) const

inlineprotected

Definition at line 182 of file ObjectMap.hpp.

Referenced by ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::do_call_method(), and ScriptInterface::Interactions::BondedInteractions::do_call_method().

insert() [1/2]

template<typename ManagedType , class BaseType = ObjectHandle, class KeyType = int>

void ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::insert ( KeyType const &  key, std::shared_ptr< ManagedType > const &  element  )

inline

Add an element to the map.

Parameters

key	Identifier of the element to add.
element	The element to add.

Definition at line 73 of file ObjectMap.hpp.

References ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::insert_in_core().

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

insert() [2/2]

template<typename ManagedType , class BaseType = ObjectHandle, class KeyType = int>

KeyType ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::insert ( std::shared_ptr< ManagedType > const &  element )

inline

Add an element to the map.

A free key is generated automatically.

Parameters

element

The element to add.

Definition at line 84 of file ObjectMap.hpp.

References ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::insert_in_core().

insert_in_core() [1/2]

template<typename ManagedType , class BaseType = ObjectHandle, class KeyType = int>

virtual void ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::insert_in_core ( KeyType const &  key, std::shared_ptr< ManagedType > const &  obj_ptr  )

privatepure virtual

insert_in_core() [2/2]

template<typename ManagedType , class BaseType = ObjectHandle, class KeyType = int>

virtual KeyType ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::insert_in_core ( std::shared_ptr< ManagedType > const &  obj_ptr )

privatepure virtual

Referenced by ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::insert(), ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::insert(), and ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::restore_from_checkpoint().

restore_from_checkpoint()

template<typename ManagedType , class BaseType = ObjectHandle, class KeyType = int>

void ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::restore_from_checkpoint ( VariantMap const &  params )

inlineprotected

Definition at line 175 of file ObjectMap.hpp.

References ScriptInterface::ObjectMap< ManagedType, BaseType, KeyType >::insert_in_core(), and params.

Referenced by ScriptInterface::Interactions::BondedInteractions::on_bind_system().

---

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

• ObjectMap.hpp