Bind parameters in the script interface. More...

#include <AutoParameters.hpp>

Inheritance diagram for ScriptInterface::AutoParameters< Derived, Base >:

Collaboration diagram for ScriptInterface::AutoParameters< Derived, Base >:

Classes
struct	UnknownParameter
	Exception thrown when accessing an unknown parameter. More...

struct	WriteError
	Exception thrown when writing to a read-only parameter. More...

Public Member Functions
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

Protected Member Functions
	AutoParameters ()=default

	AutoParameters (std::vector< AutoParameter > &&params)

void	add_parameters (std::vector< AutoParameter > &&params)

auto const &	get_parameter_insertion_order () 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.

Detailed Description

template<typename Derived, typename Base = ObjectHandle>
class ScriptInterface::AutoParameters< Derived, Base >

Bind parameters in the script interface.

This class implements ScriptInterfaceBase, binding the parameters added by add_parameters or by the constructor. To use it, derive from this class and add parameters. For example, given a class A

class A {
public:
  int i() { return m_i; }
private:
  int m_i;
};

that should have i exposed, this can be achieved by extending it like this:

class A : public AutoParameters {
public:
  A() : AutoParameters({"name_for_i", i}) {}
  int i() { return m_i; }
private:
  int m_i;
};

If there is more complicated logic needed, specific setters and getters can be provided. E.g. given a class B like

class B {
public:
  void set_i(int);
  int get_i();
private:
  int m_i;
};

we can use a lambdas to set and get the parameter like this:

class B : public AutoParameters {
public:
  B() : AutoParameters({"name_for_i",
                        [this](Variant const& v) {set_i(get_value<int>(v));},
                        [this]() {return get_i();}
                       }) {}
  void set_i(int);
  int get_i();
private:
  int m_i;
};