ScriptInterface::Constraints::HomogeneousMagneticField Class Reference

#include <HomogeneousMagneticField.hpp>

Inheritance diagram for ScriptInterface::Constraints::HomogeneousMagneticField:

Collaboration diagram for ScriptInterface::Constraints::HomogeneousMagneticField:

Public Member Functions
	HomogeneousMagneticField ()
std::shared_ptr<::Constraints::Constraint >	constraint () override
std::shared_ptr< const ::Constraints::Constraint >	constraint () const override
std::shared_ptr<::Constraints::HomogeneousMagneticField >	homogeneous_magnetic_field () const
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
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.
virtual void	do_construct (VariantMap const &params)
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.
virtual Variant	do_call_method (const std::string &, const VariantMap &)
	Local implementation of call_method.
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

Definition at line 37 of file script_interface/constraints/HomogeneousMagneticField.hpp.

Constructor & Destructor Documentation

HomogeneousMagneticField()

ScriptInterface::Constraints::HomogeneousMagneticField::HomogeneousMagneticField ( )

inline

Definition at line 39 of file script_interface/constraints/HomogeneousMagneticField.hpp.

References ScriptInterface::AutoParameters< Constraint >::add_parameters(), and ScriptInterface::get_value().

Member Function Documentation

constraint() [1/2]

std::shared_ptr< const ::Constraints::Constraint > ScriptInterface::Constraints::HomogeneousMagneticField::constraint ( ) const

inlineoverridevirtual

Implements ScriptInterface::Constraints::Constraint.

Definition at line 52 of file script_interface/constraints/HomogeneousMagneticField.hpp.

constraint() [2/2]

std::shared_ptr<::Constraints::Constraint > ScriptInterface::Constraints::HomogeneousMagneticField::constraint ( )

inlineoverridevirtual

Implements ScriptInterface::Constraints::Constraint.

Definition at line 49 of file script_interface/constraints/HomogeneousMagneticField.hpp.

homogeneous_magnetic_field()

std::shared_ptr<::Constraints::HomogeneousMagneticField > ScriptInterface::Constraints::HomogeneousMagneticField::homogeneous_magnetic_field ( ) const

inline

Definition at line 56 of file script_interface/constraints/HomogeneousMagneticField.hpp.

---

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

• script_interface/constraints/HomogeneousMagneticField.hpp