Class SubTreeVars

Class SubTreeVars#

Defined in File SubTree.h

Inheritance Relationships#

Base Type#

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

Derived Type#

public Karana::Dynamics::SubGraphVars (Class SubGraphVars)

Class Documentation#

class SubTreeVars : public Karana::Core::LockingBaseVars #

The Vars for the SubTree class.

Subclassed by Karana::Dynamics::SubGraphVars

Public Functions

SubTreeVars(const kc::ks_ptr<SubTree> &body)#

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

Parameters:: body – The body associated with this SubTreeVars.

~SubTreeVars()#: 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>> virtual_root#: The virtual root body name.

kc::ks_ptr<Karana::Core::Var_T<std::string>> physical_virtual_root#: The physical virtual root body name.

kc::ks_ptr<Karana::Core::Var_T<std::string>> parent_subtree#: The parent subtree.

kc::ks_ptr<Karana::Core::Var_T<bool>> enabled_algorithmically#: whether algorithmically enabled

kc::ks_ptr<Karana::Core::Var_T<bool>> has_compound_bodies#: whether has compound bodies

kc::ks_ptr<Karana::Core::Var_T<int>> n_bodies#: number of bodies

kc::ks_ptr<Karana::Core::Var_T<int>> n_physical_bodies#: number of physical bodies

kc::ks_ptr<Karana::Core::Var_T<int>> children_subtrees#: number of children subtrees

kc::ks_ptr<Karana::Core::Var_T<int>> nQ#: nQ

kc::ks_ptr<Karana::Core::Var_T<int>> nU#: nU

kc::ks_ptr<Karana::Core::Var_T<std::vector<std::string>>> base_bodies#: base bodies

kc::ks_ptr<Karana::Core::Var_T<std::vector<std::string>>> leaf_bodies#: leaf bodies

kc::ks_ptr<Karana::Core::Var_T<std::vector<std::string>>> coord_sanitization_subhinges#: coord sanitization subhinges

Public Static Functions

static kc::ks_ptr<SubTreeVars> create(const kc::ks_ptr<SubTree> &body)#

Create an instance of the SubTreeVars.

Parameters:: body – The body associated with this SubTreeVars.
Returns:: A pointer to the newly created instance of SubTreeVars.