Class Paramita::BooleanParameter

Represents a boolean-valued parameter.

• #include <ParameterSpace.hpp>

Inherits the following classes: Paramita::Parameter

Public Functions

Type	Name
	BooleanParameter (bool default_value) Construct a new boolean parameter.
	BooleanParameter (const BooleanParameter &)
	BooleanParameter (BooleanParameter &&) noexcept
virtual ParameterType	default_value () override const The default value for this parameter.
virtual bool	is_valid (ParameterType value) override const Checks that the value is in the domain and has the correct type.
BooleanParameter &	operator= (const BooleanParameter &) = delete
BooleanParameter &	operator= (BooleanParameter &&) = delete
	~BooleanParameter () override

Public Functions inherited from Paramita::Parameter

See Paramita::Parameter

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 BooleanParameter [1/3]

Construct a new boolean parameter.

inline explicit Paramita::BooleanParameter::BooleanParameter (
    bool default_value
) 

Parameters:

• default_value The default boolean value used when not specified.

---

function BooleanParameter [2/3]

Paramita::BooleanParameter::BooleanParameter (
    const BooleanParameter &
) 

---

function BooleanParameter [3/3]

Paramita::BooleanParameter::BooleanParameter (
    BooleanParameter &&
) noexcept

---

function default_value

The default value for this parameter.

virtual ParameterType Paramita::BooleanParameter::default_value () override const

Returns:

The default value.

Implements Paramita::Parameter::default_value

---

function is_valid

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

virtual bool Paramita::BooleanParameter::is_valid (
    ParameterType value
) override const

Parameters:

• value The value to check.

Returns:

True if the value is valid.

Implements Paramita::Parameter::is_valid

---

function operator=

BooleanParameter & Paramita::BooleanParameter::operator= (
    const BooleanParameter &
) = delete

---

function operator=

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

---

function ~BooleanParameter

Paramita::BooleanParameter::~BooleanParameter () override

---