Class EdgeFrameToFrame#

Inheritance Relationships#

Base Type#

Derived Types#

Class Documentation#

class EdgeFrameToFrame : public Karana::Frame::FrameToFrame#

Base class for an edge FrameToFrame in the frames tree.

See Coordinate Frames for more discussion on the frames layer.

Subclassed by Karana::Dynamics::PhysicalSubhinge, Karana::Frame::PrescribedFrameToFrame, Karana::Frame::SpiceFrameToFrame

Public Functions

virtual ~EdgeFrameToFrame()#

EdgeFrameToFrame destructor.

EdgeFrameToFrame(const kc::ks_ptr<Frame> &oframe, const kc::ks_ptr<Frame> &pframe, std::string_view name = "", bool supports_accels = true)#

Constructor for EdgeFrameToFrame.

Parameters:
  • oframe – oframe of the EdgeFrameToFrame.

  • pframe – pframe of the EdgeFrameToFrame.

  • name – for the edge

  • supports_accels – flag indicating whether the edge supports accels

void setSupportsAccelsFlag(bool flag)#

Set flag whether this edge supports accelerations.

Most f2fs support accelerations, but there are exceptions such as SpiceFrameToFrame and CM frame edges that do not.

Parameters:

flag – the flag whether this edge supports acceleration values.

Protected Functions

void _discard(Karana::Core::ks_ptr<Base> &base) override#

Discard the provided EdgeFrameToFrame.

Parameters:

base – - Base pointer to the EdgeFrameToFrame to discard.