Class FrameVars

• Defined in File Frame.h

Inheritance Relationships

Base Type

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

Derived Types

• public Karana::Dynamics::NodeVars (Class NodeVars)

• public Karana::Dynamics::PhysicalBodyVars (Class PhysicalBodyVars)

Class Documentation

class FrameVars : public Karana::Core::LockingBaseVars

The Vars for the Frame class.

Subclassed by Karana::Dynamics::NodeVars, Karana::Dynamics::PhysicalBodyVars

Public Functions

FrameVars(const kc::ks_ptr<Frame> &frame)

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

Parameters:

frame – The frame associated with this FrameVars.

~FrameVars()

Destructor.

virtual kc::NestedVars getAllVars() const override

Get all the Vars that this VarHolder has.

Returns:

A map of Vars, where the Var name is the key and the Var is the value.

Public Members

kc::ks_ptr<Karana::Core::Var_T<std::string>> parent_frame

The name of the frame’s parent frame.

Public Static Functions

static kc::ks_ptr<FrameVars> create(const kc::ks_ptr<Frame> &frame)

Create an instance of the FrameVars.

Parameters:

frame – The frame associated with this FrameVars.

Returns:

A pointer to the newly created instance of FrameVars.