Class CompoundSubhingeVars

• Defined in File CompoundSubhinge.h

Inheritance Relationships

Base Type

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

Class Documentation

class CompoundSubhingeVars : public Karana::Core::LockingBaseVars

The Vars for the CompoundSubhinge class.

Public Functions

CompoundSubhingeVars(const kc::ks_ptr<const CompoundSubhinge> &sh)

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

Parameters:

sh – The CompoundSubhinge associated with this CompoundSubhingeVars.

~CompoundSubhingeVars()

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>> subhinge_type

The subhinge type.

kc::ks_ptr<Karana::Core::Var_T<km::Vec>> Q

The Q coordinates.

kc::ks_ptr<Karana::Core::Var_T<km::Vec>> U

The U coordinates.

kc::ks_ptr<Karana::Core::Var_T<km::Vec>> Qdot

The Qdot coordinates.

kc::ks_ptr<Karana::Core::Var_T<km::Vec>> Udot

The Udot coordinates.

kc::ks_ptr<Karana::Core::Var_T<km::Vec>> T

The T coordinates.

Public Static Functions

static kc::ks_ptr<CompoundSubhingeVars> create(const kc::ks_ptr<const CompoundSubhinge> &sh)

Create an instance of the CompoundSubhingeVars.

Parameters:

sh – The subhinge associated with this CompoundSubhingeVars.

Returns:

A pointer to the newly created instance of CompoundSubhingeVars.