ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
ScriptInterface::Integrators::Integrator Class Referenceabstract

#include <Integrator.hpp>

+ Inheritance diagram for ScriptInterface::Integrators::Integrator:
+ Collaboration diagram for ScriptInterface::Integrators::Integrator:

Public Member Functions

Variant do_call_method (std::string const &name, VariantMap const &params) override
 
virtual Variant integrate (VariantMap const &params)
 
virtual void activate ()=0
 
virtual void deactivate ()
 
- 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
 
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.
 
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 constget_system () const
 
autoget_system ()
 
- Protected Attributes inherited from ScriptInterface::System::Leaf
std::weak_ptr<::System::Systemm_system
 

Detailed Description

Definition at line 32 of file Integrator.hpp.

Member Function Documentation

◆ activate()

virtual void ScriptInterface::Integrators::Integrator::activate ( )
pure virtual

◆ deactivate()

virtual void ScriptInterface::Integrators::Integrator::deactivate ( )
inlinevirtual

Definition at line 38 of file Integrator.hpp.

References ScriptInterface::System::Leaf::detach_system().

◆ do_call_method()

Variant Integrator::do_call_method ( std::string const name,
VariantMap const params 
)
overridevirtual

◆ integrate()


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