Class VarBase

• Defined in File VarBase.h

Inheritance Relationships

Base Type

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

Derived Type

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

Class Documentation

class VarBase : public Karana::Core::Base

Base class for all Vars.

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

Public Functions

VarBase(const VarBase&) = delete

VarBase &operator=(const VarBase&) = delete

VarBase(VarBase&&) = delete

VarBase &operator=(VarBase&) = delete

virtual VarType getType() const = 0

Get the VarType for this VarBase.

Returns:

The VarType for this VarBase.

std::string_view description() const noexcept

Description of this VarBase.

Returns:

Description of this VarBase.

std::string_view units() const noexcept

Unit string for this VarBase.

Returns:

Unit string for this VarBase.

virtual ~VarBase()

Destructor.

Protected Functions

VarBase(std::string_view name, std::string_view description, std::string_view units = "")

Using the Base constructor.

It is protected, as a VarBase should never be created directly. Use a concrete Var specialization instead.

Parameters:

• name – The name of the VarBase.

• description – A description of the VarBase.

• units – The units of the VarBase.

Protected Attributes

std::string _description

A description of the Base.

std::string _units

Units describing the stored numeric values.