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

#include <Cluster.hpp>

+ Inheritance diagram for ScriptInterface::ClusterAnalysis::Cluster:
+ Collaboration diagram for ScriptInterface::ClusterAnalysis::Cluster:

Public Member Functions

 Cluster ()=default
 
Variant do_call_method (std::string const &method, VariantMap const &parameters) override
 
void set_cluster (std::shared_ptr<::ClusterAnalysis::Cluster > const &c)
 
void set_particle_list (std::weak_ptr< Particles::ParticleList > const &handle)
 
- Public Member Functions inherited from ScriptInterface::AutoParameters< Cluster >
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.
 
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
 

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

Detailed Description

Constructor & Destructor Documentation

◆ Cluster()

ScriptInterface::ClusterAnalysis::Cluster::Cluster ( )
default

Member Function Documentation

◆ do_call_method()

Variant ScriptInterface::ClusterAnalysis::Cluster::do_call_method ( std::string const &  method,
VariantMap const &  parameters 
)
inlineoverridevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 40 of file script_interface/cluster_analysis/Cluster.hpp.

◆ set_cluster()

void ScriptInterface::ClusterAnalysis::Cluster::set_cluster ( std::shared_ptr<::ClusterAnalysis::Cluster > const &  c)
inline

◆ set_particle_list()

void ScriptInterface::ClusterAnalysis::Cluster::set_particle_list ( std::weak_ptr< Particles::ParticleList > const &  handle)
inline

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