ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
ScriptInterface::Particles::ParticleHandle Class Reference

#include <ParticleHandle.hpp>

+ Inheritance diagram for ScriptInterface::Particles::ParticleHandle:
+ Collaboration diagram for ScriptInterface::Particles::ParticleHandle:

Public Member Functions

 ParticleHandle ()
 
Variant do_call_method (std::string const &name, VariantMap const &params) override
 
void do_construct (VariantMap const &params) override
 
void attach (std::weak_ptr<::System::System > system)
 
- Public Member Functions inherited from ScriptInterface::AutoParameters< ParticleHandle >
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
 
ObjectHandleoperator= (ObjectHandle const &)=delete
 
virtual ~ObjectHandle ()=default
 
boost::string_ref name () const
 
Contextcontext () 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
 

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< ParticleHandle >
 AutoParameters ()=default
 
 AutoParameters (std::vector< AutoParameter > &&params)
 
void add_parameters (std::vector< AutoParameter > &&params)
 
auto const & get_parameter_insertion_order () const
 

Detailed Description

Definition at line 40 of file ParticleHandle.hpp.

Constructor & Destructor Documentation

◆ ParticleHandle()

Member Function Documentation

◆ attach()

void ScriptInterface::Particles::ParticleHandle::attach ( std::weak_ptr<::System::System system)
inline

◆ do_call_method()

◆ do_construct()

void ScriptInterface::Particles::ParticleHandle::do_construct ( VariantMap const params)
overridevirtual

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