vulcan::FrameRegistry Class Reference

Setup-time frame tree registry with LCA path finding. More...

#include <FrameRegistry.hpp>

Public Member Functions
	FrameRegistry ()
FrameID	register_frame (const std::string &name, FrameID parent_id)
	Register a user-defined frame as a child of an existing frame.
FramePath	find_path (FrameID from, FrameID to) const
	Find path between two frames using lowest common ancestor.
const FrameNode &	get_node (FrameID id) const
bool	has_frame (FrameID id) const
FrameID	parent_of (FrameID id) const
std::vector< FrameID >	children_of (FrameID id) const
int	depth_of (FrameID id) const
size_t	size () const

Static Public Member Functions
static FrameRegistry	default_aerospace ()

Detailed Description

Setup-time frame tree registry with LCA path finding.

Constructor & Destructor Documentation

FrameRegistry()

vulcan::FrameRegistry::FrameRegistry ( )

inline

Member Function Documentation

children_of()

std::vector< FrameID > vulcan::FrameRegistry::children_of ( FrameID id ) const

inlinenodiscard

default_aerospace()

FrameRegistry vulcan::FrameRegistry::default_aerospace ( )

inlinestaticnodiscard

depth_of()

int vulcan::FrameRegistry::depth_of ( FrameID id ) const

inlinenodiscard

find_path()

FramePath vulcan::FrameRegistry::find_path ( FrameID from, FrameID to ) const

inlinenodiscard

Find path between two frames using lowest common ancestor.

get_node()

const FrameNode & vulcan::FrameRegistry::get_node ( FrameID id ) const

inlinenodiscard

has_frame()

bool vulcan::FrameRegistry::has_frame ( FrameID id ) const

inlinenodiscard

parent_of()

FrameID vulcan::FrameRegistry::parent_of ( FrameID id ) const

inlinenodiscard

register_frame()

FrameID vulcan::FrameRegistry::register_frame ( const std::string & name, FrameID parent_id )

inline

Register a user-defined frame as a child of an existing frame.

size()

size_t vulcan::FrameRegistry::size ( ) const

inlinenodiscard

---

The documentation for this class was generated from the following file:

• include/vulcan/coordinates/FrameRegistry.hpp