Skip to content

Class Paramita::Parameter

Base class for all parameter types.

  • #include <ParameterSpace.hpp>

Public Functions

Type Name
Parameter () = default
Parameter (const Parameter &) = delete
Deleted constructor (pure interface).
Parameter (Parameter &&) = delete
Deleted constructor (pure interface).
virtual ParameterType default_value () const = 0
The default value for this parameter.
virtual bool is_valid (ParameterType value) const = 0
Checks that the value is in the domain and has the correct type.
Parameter & operator= (const Parameter & container) = delete
Deleted constructor (pure interface).
Parameter & operator= (Parameter &&) = delete
Deleted constructor (pure interface).
virtual ~Parameter () = default

Public Functions Documentation

function Parameter [1/3]

Paramita::Parameter::Parameter () = default

function Parameter [2/3]

Deleted constructor (pure interface).

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


function Parameter [3/3]

Deleted constructor (pure interface).

Paramita::Parameter::Parameter (
    Parameter &&
) = delete


function default_value

The default value for this parameter.

virtual ParameterType Paramita::Parameter::default_value () const = 0

Returns:

The default value.


function is_valid

Checks that the value is in the domain and has the correct type.

virtual bool Paramita::Parameter::is_valid (
    ParameterType value
) const = 0

Parameters:

  • value The value to check.

Returns:

True if the value is valid.


function operator=

Deleted constructor (pure interface).

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


function operator=

Deleted constructor (pure interface).

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


function ~Parameter

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