ScriptInterface::Particles::ParticleList Class Reference

#include <ParticleList.hpp>

Inheritance diagram for ScriptInterface::Particles::ParticleList:

Collaboration diagram for ScriptInterface::Particles::ParticleList:

Public Member Functions
Variant	do_call_method (std::string const &name, VariantMap const &params) override
void	do_construct (VariantMap const &) override
void	attach (std::weak_ptr< CellSystem::CellSystem > cell_structure, std::weak_ptr< Interactions::BondedInteractions > bonded_ias)
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.
VariantMap	get_parameters () const
	Get current parameters.
virtual std::span< const boost::string_ref >	valid_parameters () const
	Get required and optional parameters for class.
auto	get_valid_parameters () const
virtual Variant	get_parameter (std::string const &name) const
	Get single parameter.
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
virtual std::vector< std::pair< std::string, Variant > >	serialize_parameters () const
	Serialize parameters.

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::System::Leaf
auto const &	get_system () const
auto &	get_system ()
Protected Attributes inherited from ScriptInterface::System::Leaf
std::weak_ptr<::System::System >	m_system

Detailed Description

Definition at line 33 of file script_interface/particle_data/ParticleList.hpp.

Member Function Documentation

attach()

void ScriptInterface::Particles::ParticleList::attach ( std::weak_ptr< CellSystem::CellSystem >  cell_structure, std::weak_ptr< Interactions::BondedInteractions >  bonded_ias  )

inline

Definition at line 49 of file script_interface/particle_data/ParticleList.hpp.

do_call_method()

Variant ScriptInterface::Particles::ParticleList::do_call_method ( std::string const &  name, VariantMap const &  params  )

overridevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 143 of file ParticleList.cpp.

References ScriptInterface::Particles::auto_exclusions(), ScriptInterface::ObjectHandle::context(), get_maximal_particle_id(), get_n_part(), get_particle_ids(), ScriptInterface::get_value(), ScriptInterface::Context::make_shared(), ScriptInterface::ObjectHandle::name(), params, particle_exists(), and remove_all_particles().

do_construct()

void ScriptInterface::Particles::ParticleList::do_construct ( VariantMap const &  )

inlineoverridevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 47 of file script_interface/particle_data/ParticleList.hpp.

---

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

• script_interface/particle_data/ParticleList.hpp
• ParticleList.cpp