ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
ScriptInterface::Dipoles::DipolarP3M< Architecture > Class Template Reference

#include <DipolarP3M.hpp>

+ Inheritance diagram for ScriptInterface::Dipoles::DipolarP3M< Architecture >:
+ Collaboration diagram for ScriptInterface::Dipoles::DipolarP3M< Architecture >:

Public Types

using Base = Actor< DipolarP3M< Architecture >, ::DipolarP3M >
 

Public Member Functions

 DipolarP3M ()
 
void do_construct (VariantMap const &params) override
 
- Public Member Functions inherited from ScriptInterface::Dipoles::Actor< DipolarP3M< Architecture >, ::DipolarP3M >
 Actor ()
 
Variant do_call_method (std::string const &name, VariantMap const &params) override
 
std::shared_ptr< CoreActorClassactor ()
 
std::shared_ptr< CoreActorClass const > actor () const
 
- Public Member Functions inherited from ScriptInterface::AutoParameters< Derived, Base >
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 Types inherited from ScriptInterface::Dipoles::Actor< DipolarP3M< Architecture >, ::DipolarP3M >
using SIActorClass = DipolarP3M< Architecture >
 
using CoreActorClass = ::DipolarP3M
 
using ObjectClass = Actor< DipolarP3M< Architecture >, ::DipolarP3M >
 
- Protected Member Functions inherited from ScriptInterface::Dipoles::Actor< DipolarP3M< Architecture >, ::DipolarP3M >
void on_bind_system (::System::System &) override
 
- Protected Member Functions inherited from ScriptInterface::AutoParameters< Derived, Base >
 AutoParameters ()=default
 
 AutoParameters (std::vector< AutoParameter > &&params)
 
void add_parameters (std::vector< AutoParameter > &&params)
 
auto const & get_parameter_insertion_order () const
 
- Protected Attributes inherited from ScriptInterface::Dipoles::Actor< DipolarP3M< Architecture >, ::DipolarP3M >
std::shared_ptr< CoreActorClassm_actor
 

Detailed Description

template<Arch Architecture>
class ScriptInterface::Dipoles::DipolarP3M< Architecture >

Definition at line 49 of file DipolarP3M.hpp.

Member Typedef Documentation

◆ Base

template<Arch Architecture>
using ScriptInterface::Dipoles::DipolarP3M< Architecture >::Base = Actor<DipolarP3M<Architecture>, ::DipolarP3M>

Definition at line 56 of file DipolarP3M.hpp.

Constructor & Destructor Documentation

◆ DipolarP3M()

Member Function Documentation

◆ do_construct()

template<Arch Architecture>
void ScriptInterface::Dipoles::DipolarP3M< Architecture >::do_construct ( VariantMap const &  params)
inlineoverridevirtual

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