Class Var

• Defined in File Var.h

Inheritance Relationships

Base Type

• public Karana::Core::Base (Class Base)

Derived Type

• public Karana::Core::Var_T< T > (Template Class Var_T)

Class Documentation

class Var : public Karana::Core::Base

Base class for all Vars.

Subclassed by Karana::Core::Var_T< T >

Public Functions

Var(const Var&) = delete

Var &operator=(const Var&) = delete

Var(Var&&) = delete

Var &operator=(Var&) = delete

virtual VarType getType() const = 0

Get the VarType for this Var.

Returns:

The VarType for this Var.

std::string_view description() const noexcept

Description of this Var.

Returns:

Description of this Var.

std::string_view quantity() const noexcept

Quantity type of this Var.

Returns:

Quantity type of this Var.

virtual ~Var()

Destructor.

Protected Functions

Var(std::string_view name, std::string_view description, std::string_view quantity = "")

Using the Base constructor.

It is protected, as a Var should never be created directly. Only Var_Ts should be created.

Parameters:

• name – The name of the Var.

• description – A description of the Var.

• quantity – The quantity of the Var.

Protected Attributes

std::string _description

A description of the Base.

std::string _quantity

The name of the Base.