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.