Class OrientedChainedFrameToFrameVars

• Defined in File OrientedChainedFrameToFrame.h

Inheritance Relationships

Base Type

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

Derived Type

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

Class Documentation

class OrientedChainedFrameToFrameVars : public Karana::Frame::FrameToFrameVars

The Vars for the OrientedChainedFrameToFrame class.

Subclassed by Karana::Dynamics::FramePairHingeVars

Public Functions

OrientedChainedFrameToFrameVars(const kc::ks_ptr<OrientedChainedFrameToFrame> &f2f)

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

Parameters:

f2f – The f2f associated with this OrientedChainedFrameToFrameVars.

~OrientedChainedFrameToFrameVars()

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::vector<std::string>>> oriented_f2f_edges

the oframe to pframe path

kc::ks_ptr<Karana::Core::Var_T<int>> num_f2f_edges

the number of f2f edges in the chain

Public Static Functions

static kc::ks_ptr<OrientedChainedFrameToFrameVars> create(const kc::ks_ptr<OrientedChainedFrameToFrame> &f2f)

Create an instance of the OrientedChainedFrameToFrameVars.

Parameters:

f2f – The f2f associated with this OrientedChainedFrameToFrameVars.

Returns:

A pointer to the newly created instance of OrientedChainedFrameToFrameVars.