Class LockingBaseVars

• Defined in File LockingBase.h

Inheritance Relationships

Base Type

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

Derived Types

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

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

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

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

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

• public Karana::Frame::FrameToFrameVars (Class FrameToFrameVars)

• public Karana::Frame::FrameVars (Class FrameVars)

Class Documentation

class LockingBaseVars : public Karana::Core::BaseVars

The Vars for the LockingBase class.

Subclassed by Karana::Dynamics::BilateralConstraintBaseVars, Karana::Dynamics::CompoundBodyVars, Karana::Dynamics::ConstraintKinematicsSolverVars, Karana::Dynamics::CoordDataVars, Karana::Dynamics::SubTreeVars, Karana::Frame::FrameToFrameVars, Karana::Frame::FrameVars

Public Functions

LockingBaseVars(const ks_ptr<LockingBase> &lb)

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

Parameters:

lb – The LockingBase associated with this LockingBaseVars.

~LockingBaseVars()

Destructor.

virtual Karana::Core::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

ks_ptr<Karana::Core::Var_T<bool>> healthy

The health status.

ks_ptr<Karana::Core::Var_T<std::vector<std::string>>> upstream_deps

The upstream dependencies.

ks_ptr<Karana::Core::Var_T<std::vector<std::string>>> downstream_deps

The downstream dependencies.

Public Static Functions

static ks_ptr<LockingBaseVars> create(const ks_ptr<LockingBase> &body)

Create an instance of the LockingBaseVars.

Parameters:

body – The body associated with this LockingBaseVars.

Returns:

A pointer to the newly created instance of LockingBaseVars.