ScriptInterface::Dipoles::DipolarLayerCorrection Class Reference

#include <DipolarLayerCorrection.hpp>

Inheritance diagram for ScriptInterface::Dipoles::DipolarLayerCorrection:

Collaboration diagram for ScriptInterface::Dipoles::DipolarLayerCorrection:

Public Member Functions
	DipolarLayerCorrection ()
void	do_construct (VariantMap const &params) override
Public Member Functions inherited from ScriptInterface::Dipoles::Actor< DipolarLayerCorrection, ::DipolarLayerCorrection >
	Actor ()
Variant	do_call_method (std::string const &name, VariantMap const &params) override
std::shared_ptr< CoreActorClass >	actor ()
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
ObjectHandle &	operator= (ObjectHandle const &)=delete
virtual	~ObjectHandle ()=default
boost::string_ref	name () const
Context *	context () 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

Private Member Functions
void	on_bind_system (::System::System &system) override

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< DipolarLayerCorrection, ::DipolarLayerCorrection >
using	SIActorClass = DipolarLayerCorrection
using	CoreActorClass = ::DipolarLayerCorrection
using	ObjectClass = Actor< DipolarLayerCorrection, ::DipolarLayerCorrection >
Protected Member Functions inherited from ScriptInterface::Dipoles::Actor< DipolarLayerCorrection, ::DipolarLayerCorrection >
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< DipolarLayerCorrection, ::DipolarLayerCorrection >
std::shared_ptr< CoreActorClass >	m_actor

Detailed Description

Definition at line 43 of file DipolarLayerCorrection.hpp.

Constructor & Destructor Documentation

DipolarLayerCorrection()

ScriptInterface::Dipoles::DipolarLayerCorrection::DipolarLayerCorrection ( )

inline

Definition at line 60 of file DipolarLayerCorrection.hpp.

References ScriptInterface::Dipoles::Actor< DipolarLayerCorrection, ::DipolarLayerCorrection >::actor(), ScriptInterface::AutoParameters< Derived, Base >::add_parameters(), and ScriptInterface::AutoParameter::read_only.

Member Function Documentation

do_construct()

void ScriptInterface::Dipoles::DipolarLayerCorrection::do_construct ( VariantMap const &  params )

inlineoverridevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 76 of file DipolarLayerCorrection.hpp.

References ScriptInterface::ObjectHandle::context(), ScriptInterface::get_value(), ScriptInterface::Dipoles::Actor< DipolarLayerCorrection, ::DipolarLayerCorrection >::m_actor, ScriptInterface::Context::parallel_try_catch(), and params.

on_bind_system()

void ScriptInterface::Dipoles::DipolarLayerCorrection::on_bind_system ( ::System::System &  system )

inlineoverrideprivate

Definition at line 53 of file DipolarLayerCorrection.hpp.

---

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

• DipolarLayerCorrection.hpp