Drake
FrameTopology Struct Reference

Data structure to store the topological information associated with a Frame. More...

#include <multibody/multibody_tree/multibody_tree_topology.h>

Collaboration diagram for FrameTopology:
[legend]

Public Member Functions

 FrameTopology ()
 
 FrameTopology (FrameIndex frame_index, BodyIndex body_index)
 Constructs a frame topology for a frame with index frame_index associated with a body with index body_index. More...
 
bool operator== (const FrameTopology &other) const
 Returns true if all members of this topology are exactly equal to the members of other. More...
 
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
 FrameTopology (const FrameTopology &)=default
 
FrameTopologyoperator= (const FrameTopology &)=default
 
 FrameTopology (FrameTopology &&)=default
 
FrameTopologyoperator= (FrameTopology &&)=default
 

Public Attributes

FrameIndex index {0}
 Unique index in the MultibodyTree. More...
 
BodyIndex body {0}
 Unique index of the body this physical frame attaches to. More...
 

Detailed Description

Data structure to store the topological information associated with a Frame.

Constructor & Destructor Documentation

FrameTopology ( const FrameTopology )
default
FrameTopology ( FrameTopology &&  )
default
FrameTopology ( )
inline
FrameTopology ( FrameIndex  frame_index,
BodyIndex  body_index 
)
inline

Constructs a frame topology for a frame with index frame_index associated with a body with index body_index.

Member Function Documentation

FrameTopology& operator= ( const FrameTopology )
default
FrameTopology& operator= ( FrameTopology &&  )
default
bool operator== ( const FrameTopology other) const
inline

Returns true if all members of this topology are exactly equal to the members of other.

Member Data Documentation

BodyIndex body {0}

Unique index of the body this physical frame attaches to.

FrameIndex index {0}

Unique index in the MultibodyTree.


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