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

Base class for script interfaces to core observables classes. More...

#include <Observable.hpp>

+ Inheritance diagram for ScriptInterface::Observables::Observable:
+ Collaboration diagram for ScriptInterface::Observables::Observable:

Public Member Functions

virtual std::shared_ptr<::Observables::Observableobservable () const =0
 
Variant do_call_method (std::string const &method, VariantMap const &parameters) override
 
- 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.
 

Detailed Description

Base class for script interfaces to core observables classes.

Definition at line 38 of file script_interface/observables/Observable.hpp.

Member Function Documentation

◆ do_call_method()

Variant ScriptInterface::Observables::Observable::do_call_method ( std::string const method,
VariantMap const parameters 
)
inlineoverridevirtual

◆ observable()

virtual std::shared_ptr<::Observables::Observable > ScriptInterface::Observables::Observable::observable ( ) const
pure virtual

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