ScriptInterface::Constraints::Constraint Class Reference

#include <Constraint.hpp>

Inheritance diagram for ScriptInterface::Constraints::Constraint:

Collaboration diagram for ScriptInterface::Constraints::Constraint:

Public Member Functions
virtual std::shared_ptr< const ::Constraints::Constraint >	constraint () const =0
virtual std::shared_ptr<::Constraints::Constraint >	constraint ()=0
virtual void	bind_system (std::shared_ptr<::System::System const > const &)
Public Member Functions inherited from ScriptInterface::AutoParameters< Constraint >
std::vector< std::string_view >	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
std::string_view	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.
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)
	~AutoParameters () override=default
bool	has_parameter (std::string const &name) const override
void	add_parameters (std::vector< AutoParameter > &&params)
auto const &	get_parameter_insertion_order () const

Detailed Description

Definition at line 35 of file script_interface/constraints/Constraint.hpp.

Member Function Documentation

bind_system()

virtual void ScriptInterface::Constraints::Constraint::bind_system ( std::shared_ptr<::System::System const > const &  )

inlinevirtual

Reimplemented in ScriptInterface::Constraints::ShapeBasedConstraint.

Definition at line 40 of file script_interface/constraints/Constraint.hpp.

constraint() [1/2]

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

pure virtual

Implemented in ScriptInterface::Constraints::ExternalField< Coupling, Field >, ScriptInterface::Constraints::ExternalPotential< Coupling, Field >, ScriptInterface::Constraints::HomogeneousMagneticField, and ScriptInterface::Constraints::ShapeBasedConstraint.

constraint() [2/2]

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

pure virtual

Implemented in ScriptInterface::Constraints::ExternalField< Coupling, Field >, ScriptInterface::Constraints::ExternalPotential< Coupling, Field >, ScriptInterface::Constraints::HomogeneousMagneticField, and ScriptInterface::Constraints::ShapeBasedConstraint.

---

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

• script_interface/constraints/Constraint.hpp