ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
ScriptInterface::Observables::ParamlessObservableInterface< CoreObs > Class Template Reference

Cython interface for parameter-free observables. More...

#include <ParamlessObservable.hpp>

+ Inheritance diagram for ScriptInterface::Observables::ParamlessObservableInterface< CoreObs >:
+ Collaboration diagram for ScriptInterface::Observables::ParamlessObservableInterface< CoreObs >:

Public Member Functions

 ParamlessObservableInterface ()
 
std::shared_ptr<::Observables::Observableobservable () const override
 
- Public Member Functions inherited from ScriptInterface::Observables::Observable
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

template<class CoreObs>
class ScriptInterface::Observables::ParamlessObservableInterface< CoreObs >

Cython interface for parameter-free observables.

Create new observables with NEW_PARAMLESS_OBSERVABLE.

Template Parameters
CoreObsThe core class exposed in Cython by this class.

Definition at line 49 of file ParamlessObservable.hpp.

Constructor & Destructor Documentation

◆ ParamlessObservableInterface()

template<class CoreObs >
ScriptInterface::Observables::ParamlessObservableInterface< CoreObs >::ParamlessObservableInterface ( )
inline

Definition at line 51 of file ParamlessObservable.hpp.

Member Function Documentation

◆ observable()

template<class CoreObs >
std::shared_ptr<::Observables::Observable > ScriptInterface::Observables::ParamlessObservableInterface< CoreObs >::observable ( ) const
inlineoverridevirtual

Implements ScriptInterface::Observables::Observable.

Definition at line 53 of file ParamlessObservable.hpp.


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