Class Paramita::Plugin¶

Provides capabilities to tweak parameters from the inheriting class.

This abstract class defines a common interface to get and set parameters from/to the inheriting classes, as well as a way to peek which parameters it has.

#include <Plugin.hpp>

Public Static Attributes¶

Type	Name
constexpr const char *const	m_interface_id = `"Paramita::Plugin"`

Public Functions¶

Type	Name
	Plugin () = default
	Plugin (const Plugin &) = delete Deleted constructor (pure interface).
	Plugin (Plugin &&) = delete Deleted constructor (pure interface).
virtual ParameterType	get (const std::string & name) Get the parameter's value.
virtual ParameterSpace	get_parameter_space () Get the parameter space for this class.
Plugin &	operator= (const Plugin & container) = delete Deleted constructor (pure interface).
Plugin &	operator= (Plugin &&) = delete Deleted constructor (pure interface).
virtual	set (const std::string & name, const ParameterType & value) Set a parameter.
virtual	~Plugin () = default

Public Static Attributes Documentation¶

variable m_interface_id¶

constexpr const char* const Paramita::Plugin::m_interface_id;

Public Functions Documentation¶

function Plugin [1/3]¶

Paramita::Plugin::Plugin () = default

function Plugin [2/3]¶

Deleted constructor (pure interface).

Paramita::Plugin::Plugin (
    const Plugin &
) = delete

function Plugin [3/3]¶

Deleted constructor (pure interface).

Paramita::Plugin::Plugin (
    Plugin &&
) = delete

function get¶

Get the parameter's value.

virtual ParameterType Paramita::Plugin::get (
    const std::string & name
)

Parameters:

name The name of the parameter.

Returns:

The value of the parameter.

function get_parameter_space¶

Get the parameter space for this class.

virtual ParameterSpace Paramita::Plugin::get_parameter_space ()

Returns:

The parameter space.

function operator=¶

Deleted constructor (pure interface).

Plugin & Paramita::Plugin::operator= (
    const Plugin & container
) = delete

function operator=¶

Deleted constructor (pure interface).

Plugin & Paramita::Plugin::operator= (
    Plugin &&
) = delete

function set¶

Set a parameter.

virtual Paramita::Plugin::set (
    const std::string & name,
    const ParameterType & value
)

Parameters:

name The name of the parameter.
value The value to set the parameter to.

Exception:

std::invalid_argument If the parameter does not exist in the space.
std::invalid_argument If the parameter value is not valid for this name.

function ~Plugin¶

virtual Paramita::Plugin::~Plugin () = default