ScriptInterface::Dipoles::Actor< SIClass, CoreClass > Class Template Reference

Common interface for magnetostatic actors. More...

#include <Actor.hpp>

Inheritance diagram for ScriptInterface::Dipoles::Actor< SIClass, CoreClass >:

Collaboration diagram for ScriptInterface::Dipoles::Actor< SIClass, CoreClass >:

Public Member Functions
	Actor ()
Variant	do_call_method (std::string const &name, VariantMap const &params) override
std::shared_ptr< CoreActorClass >	actor ()
std::shared_ptr< CoreActorClass const >	actor () const
Public Member Functions inherited from ScriptInterface::AutoParameters< Actor< SIClass, CoreClass >, System::Leaf >
std::span< const boost::string_ref >	valid_parameters () const final
Variant	get_parameter (const std::string &name) const final
void	do_set_parameter (const std::string &name, const Variant &value) final
std::vector< std::pair< std::string, Variant > >	serialize_parameters () const final
Public Member Functions inherited from ScriptInterface::System::Leaf
void	bind_system (std::shared_ptr<::System::System > const &system)
void	detach_system ()
Public Member Functions inherited from ScriptInterface::ObjectHandle
	ObjectHandle ()=default
	ObjectHandle (ObjectHandle const &)=delete
ObjectHandle &	operator= (ObjectHandle const &)=delete
virtual	~ObjectHandle ()=default
boost::string_ref	name () const
Context *	context () const
	Responsible context.
void	construct (VariantMap const &params)
	Construct the handled object.
virtual void	do_construct (VariantMap const &params)
VariantMap	get_parameters () const
	Get current parameters.
auto	get_valid_parameters () const
void	set_parameter (const std::string &name, const Variant &value)
	Set single parameter.
Variant	call_method (const std::string &name, const VariantMap &params)
	Call a method on the object.
std::string	serialize () const

Protected Types
using	SIActorClass = SIClass
using	CoreActorClass = CoreClass
using	ObjectClass = Actor< SIClass, CoreClass >

Protected Member Functions
void	on_bind_system (::System::System &) override
Protected Member Functions inherited from ScriptInterface::AutoParameters< Actor< SIClass, CoreClass >, System::Leaf >
	AutoParameters ()=default
	AutoParameters (std::vector< AutoParameter > &&params)
void	add_parameters (std::vector< AutoParameter > &&params)
auto const &	get_parameter_insertion_order () const
Protected Member Functions inherited from ScriptInterface::System::Leaf
auto const &	get_system () const
auto &	get_system ()

Protected Attributes
std::shared_ptr< CoreActorClass >	m_actor
Protected Attributes inherited from ScriptInterface::System::Leaf
std::weak_ptr<::System::System >	m_system

Additional Inherited Members
Static Public Member Functions inherited from ScriptInterface::ObjectHandle
static ObjectRef	deserialize (const std::string &state, Context &ctx)
	Make object from serialized state.

Detailed Description

template<class SIClass, class CoreClass>
class ScriptInterface::Dipoles::Actor< SIClass, CoreClass >

Common interface for magnetostatic actors.

Several methods are defined in initialize.cpp since they depend on symbols only available in dipoles.hpp, which cannot be included in this header file for separation of concerns reasons.

Definition at line 45 of file magnetostatics/Actor.hpp.

Member Typedef Documentation

CoreActorClass

template<class SIClass , class CoreClass >

using ScriptInterface::Dipoles::Actor< SIClass, CoreClass >::CoreActorClass = CoreClass

protected

Definition at line 48 of file magnetostatics/Actor.hpp.

ObjectClass

template<class SIClass , class CoreClass >

using ScriptInterface::Dipoles::Actor< SIClass, CoreClass >::ObjectClass = Actor<SIClass, CoreClass>

protected

Definition at line 49 of file magnetostatics/Actor.hpp.

SIActorClass

template<class SIClass , class CoreClass >

using ScriptInterface::Dipoles::Actor< SIClass, CoreClass >::SIActorClass = SIClass

protected

Definition at line 47 of file magnetostatics/Actor.hpp.

Constructor & Destructor Documentation

Actor()

template<class SIClass , class CoreClass >

ScriptInterface::Dipoles::Actor< SIClass, CoreClass >::Actor ( )

inline

Definition at line 61 of file magnetostatics/Actor.hpp.

References ScriptInterface::Dipoles::Actor< SIClass, CoreClass >::actor(), ScriptInterface::AutoParameters< Actor< SIClass, CoreClass >, System::Leaf >::add_parameters(), and ScriptInterface::AutoParameter::read_only.

Member Function Documentation

actor() [1/2]

template<class SIClass , class CoreClass >

std::shared_ptr< CoreActorClass > ScriptInterface::Dipoles::Actor< SIClass, CoreClass >::actor ( )

inline

Definition at line 71 of file magnetostatics/Actor.hpp.

References ScriptInterface::Dipoles::Actor< SIClass, CoreClass >::m_actor.

Referenced by ScriptInterface::Dipoles::Actor< SIClass, CoreClass >::Actor().

actor() [2/2]

template<class SIClass , class CoreClass >

std::shared_ptr< CoreActorClass const > ScriptInterface::Dipoles::Actor< SIClass, CoreClass >::actor ( ) const

inline

Definition at line 72 of file magnetostatics/Actor.hpp.

References ScriptInterface::Dipoles::Actor< SIClass, CoreClass >::m_actor.

do_call_method()

template<class SIClass , class CoreClass >

Variant ScriptInterface::Dipoles::Actor< SIClass, CoreClass >::do_call_method ( std::string const &  name, VariantMap const &  params  )

overridevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Reimplemented in ScriptInterface::Dipoles::DipolarScafacos.

Definition at line 40 of file magnetostatics/Actor.impl.hpp.

References add_actor(), and params.

Referenced by ScriptInterface::Dipoles::DipolarScafacos::do_call_method().

on_bind_system()

template<class SIClass , class CoreClass >

void ScriptInterface::Dipoles::Actor< SIClass, CoreClass >::on_bind_system ( ::System::System &  )

inlineoverrideprotectedvirtual

Reimplemented from ScriptInterface::System::Leaf.

Definition at line 56 of file magnetostatics/Actor.hpp.

References ScriptInterface::Dipoles::Actor< SIClass, CoreClass >::m_actor, and ScriptInterface::System::Leaf::m_system.

Member Data Documentation

m_actor

template<class SIClass , class CoreClass >

std::shared_ptr<CoreActorClass> ScriptInterface::Dipoles::Actor< SIClass, CoreClass >::m_actor

protected

Definition at line 54 of file magnetostatics/Actor.hpp.

Referenced by ScriptInterface::Dipoles::Actor< SIClass, CoreClass >::actor(), ScriptInterface::Dipoles::Actor< SIClass, CoreClass >::actor(), and ScriptInterface::Dipoles::Actor< SIClass, CoreClass >::on_bind_system().

---

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

• magnetostatics/Actor.hpp
• magnetostatics/Actor.impl.hpp