ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
ScriptInterface::Constraints::ExternalField< Coupling, Field > Class Template Reference

#include <ExternalField.hpp>

+ Inheritance diagram for ScriptInterface::Constraints::ExternalField< Coupling, Field >:
+ Collaboration diagram for ScriptInterface::Constraints::ExternalField< Coupling, Field >:

Public Member Functions

 ExternalField ()
 
void do_construct (VariantMap const &args) override
 
Variant do_call_method (const std::string &name, VariantMap const &args) override
 
std::shared_ptr<::Constraints::Constraintconstraint () override
 
std::shared_ptr< const ::Constraints::Constraintconstraint () const override
 
- Public Member Functions inherited from ScriptInterface::Constraints::Constraint
virtual void bind_system (std::shared_ptr<::System::System const > const &)
 
- Public Member Functions inherited from ScriptInterface::AutoParameters< Constraint >
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 Member Functions inherited from ScriptInterface::AutoParameters< Constraint >
 AutoParameters ()=default
 
 AutoParameters (std::vector< AutoParameter > &&params)
 
void add_parameters (std::vector< AutoParameter > &&params)
 
auto const & get_parameter_insertion_order () const
 

Detailed Description

template<typename Coupling, typename Field>
class ScriptInterface::Constraints::ExternalField< Coupling, Field >

Definition at line 42 of file script_interface/constraints/ExternalField.hpp.

Constructor & Destructor Documentation

◆ ExternalField()

Member Function Documentation

◆ constraint() [1/2]

template<typename Coupling , typename Field >
std::shared_ptr< const ::Constraints::Constraint > ScriptInterface::Constraints::ExternalField< Coupling, Field >::constraint ( ) const
inlineoverridevirtual

◆ constraint() [2/2]

template<typename Coupling , typename Field >
std::shared_ptr<::Constraints::Constraint > ScriptInterface::Constraints::ExternalField< Coupling, Field >::constraint ( )
inlineoverridevirtual

◆ do_call_method()

template<typename Coupling , typename Field >
Variant ScriptInterface::Constraints::ExternalField< Coupling, Field >::do_call_method ( const std::string &  name,
VariantMap const args 
)
inlineoverridevirtual

◆ do_construct()

template<typename Coupling , typename Field >
void ScriptInterface::Constraints::ExternalField< Coupling, Field >::do_construct ( VariantMap const args)
inlineoverridevirtual

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