Class TimeKeeperVars

• Defined in File TimeKeeper.h

Inheritance Relationships

Base Type

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

Class Documentation

class TimeKeeperVars : public Karana::Core::BaseVars

Vars for the TimeKeeper class.

Public Functions

TimeKeeperVars(const kc::ks_ptr<const TimeKeeper> time_keeper)

TimeKeeperVars constructor. The constructor is not meant to be called directly. Please use the create(…) method instead to create an instance.

Parameters:

time_keeper – The TimeKeeper associated with these vars.

~TimeKeeperVars()

Destructor.

virtual kc::NestedVars getAllVars() const override

Get all the Vars that this TimeKeeperVars has.

Returns:

A NestedVars struct with all of this TimeKeeperVars’s vars.

Public Members

kc::ks_ptr<kc::Var_T<double>> time

The current time.

Public Static Functions

static kc::ks_ptr<TimeKeeperVars> create(const kc::ks_ptr<const TimeKeeper> time_keeper)

Create a new instanced of TimeKeeperVars.

Parameters:

time_keeper – The TimeKeeper associated with these vars.

Returns:

A pointer to the newly created instance of TimeKeeperVars.