ScriptInterface::LeesEdwards::Protocol Class Reference

#include <Protocol.hpp>

Inheritance diagram for ScriptInterface::LeesEdwards::Protocol:

Collaboration diagram for ScriptInterface::LeesEdwards::Protocol:

Public Member Functions
virtual std::shared_ptr<::LeesEdwards::ActiveProtocol >	protocol ()=0
Public Member Functions inherited from ScriptInterface::AutoParameters< Protocol >
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< Protocol >
	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 32 of file lees_edwards/Protocol.hpp.

Member Function Documentation

protocol()

virtual std::shared_ptr<::LeesEdwards::ActiveProtocol > ScriptInterface::LeesEdwards::Protocol::protocol ( )

pure virtual

Implemented in ScriptInterface::LeesEdwards::LinearShear, ScriptInterface::LeesEdwards::Off, and ScriptInterface::LeesEdwards::OscillatoryShear.

---

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

• lees_edwards/Protocol.hpp