Skip to content

Class Paramita::InterfaceParameter

template

Inherits the following classes: Paramita::Parameter

Public Functions

Type Name
InterfaceParameter ()
InterfaceParameter (const InterfaceParameter &)
InterfaceParameter (InterfaceParameter &&) 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.
InterfaceParameter & operator= (const InterfaceParameter &) = delete
InterfaceParameter & operator= (InterfaceParameter &&) noexcept
~InterfaceParameter () 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 InterfaceParameter [1/3]

inline explicit Paramita::InterfaceParameter::InterfaceParameter () 

function InterfaceParameter [2/3]

inline Paramita::InterfaceParameter::InterfaceParameter (
    const InterfaceParameter &
) 

function InterfaceParameter [3/3]

inline Paramita::InterfaceParameter::InterfaceParameter (
    InterfaceParameter &&
) noexcept

function default_value

The default value for this parameter.

inline virtual ParameterType Paramita::InterfaceParameter::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.

inline virtual bool Paramita::InterfaceParameter::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=

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

function operator=

InterfaceParameter & Paramita::InterfaceParameter::operator= (
    InterfaceParameter &&
) noexcept

function ~InterfaceParameter

Paramita::InterfaceParameter::~InterfaceParameter () override