Script interface wrapper for the system class. More...

#include <System.hpp>

Inheritance diagram for ScriptInterface::System::System:

Collaboration diagram for ScriptInterface::System::System:

Classes
struct	Leaves
	Container for leaves of the system class. More...

Public Member Functions
	System ()

void	do_construct (VariantMap const &params) override

Variant	do_call_method (std::string const &name, VariantMap const &parameters) override

auto const &	get_system () const

Public Member Functions inherited from ScriptInterface::AutoParameters< System >
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::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.

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

Private Member Functions
std::string	get_internal_state () const override
	Serialize particles.

void	set_internal_state (std::string const &state) override

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.

Protected Member Functions inherited from ScriptInterface::AutoParameters< System >
	AutoParameters ()=default

	AutoParameters (std::vector< AutoParameter > &&params)

void	add_parameters (std::vector< AutoParameter > &&params)

auto const &	get_parameter_insertion_order () const

Detailed Description

Script interface wrapper for the system class.

See System class design for more details.

Definition at line 38 of file script_interface/system/System.hpp.

Constructor & Destructor Documentation

◆ System()

ScriptInterface::System::System::System ( )

Definition at line 129 of file script_interface/system/System.cpp.

References ScriptInterface::AutoParameters< System >::add_parameters(), and ScriptInterface::get_value().

Member Function Documentation

◆ do_call_method()

Variant ScriptInterface::System::System::do_call_method	(	std::string const &	name,
		VariantMap const &	parameters
	)

overridevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 380 of file script_interface/system/System.cpp.

References Utils::Vector< T, N >::broadcast(), coord(), System::get_system(), ScriptInterface::get_value(), init_type_map(), ScriptInterface::make_unordered_map_of_variants(), propagation_flags_map(), ScriptInterface::System::rescale_particles(), System::reset_system(), ScriptInterface::System::rotate_system(), and ScriptInterface::System::system_created.

◆ do_construct()

void ScriptInterface::System::System::do_construct ( VariantMap const & params )

overridevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 223 of file script_interface/system/System.cpp.

References System::System::create(), ScriptInterface::get_value(), NSQUARE, params, REGULAR, System::set_system(), and ScriptInterface::System::system_created.

◆ get_internal_state()

std::string ScriptInterface::System::System::get_internal_state ( ) const

overrideprivatevirtual

Serialize particles.

Particles need to be serialized here to reduce overhead, and also to guarantee particles get instantiated after the cell structure was instantiated (since they store a weak pointer to it).

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 483 of file script_interface/system/System.cpp.

References get_particle_ids(), ScriptInterface::get_value(), ScriptInterface::pack(), Utils::pack(), and ScriptInterface::ObjectHandle::serialize().