Drake
ForceElementTopology Struct Reference

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

#include <drake/multibody/multibody_tree/multibody_tree_topology.h>

Public Member Functions

 ForceElementTopology ()
 Default construction to an invalid configuration. More...
 
 ForceElementTopology (ForceElementIndex force_element_index)
 Constructs a force element topology with index force_element_index. More...
 
bool operator== (const ForceElementTopology &other) const
 Returns true if all members of this topology are exactly equal to the members of other. More...
 
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
 ForceElementTopology (const ForceElementTopology &)=default
 
ForceElementTopologyoperator= (const ForceElementTopology &)=default
 
 ForceElementTopology (ForceElementTopology &&)=default
 
ForceElementTopologyoperator= (ForceElementTopology &&)=default
 

Public Attributes

ForceElementIndex index {0}
 Unique index in the MultibodyTree. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ForceElementTopology() [1/4]

◆ ForceElementTopology() [2/4]

◆ ForceElementTopology() [3/4]

Default construction to an invalid configuration.

This only exists to satisfy demands of working with various container classes.

◆ ForceElementTopology() [4/4]

ForceElementTopology ( ForceElementIndex  force_element_index)
inlineexplicit

Constructs a force element topology with index force_element_index.

Member Function Documentation

◆ operator=() [1/2]

ForceElementTopology& operator= ( const ForceElementTopology )
default

◆ operator=() [2/2]

ForceElementTopology& operator= ( ForceElementTopology &&  )
default

◆ operator==()

bool operator== ( const ForceElementTopology other) const
inline

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

Member Data Documentation

◆ index

ForceElementIndex index {0}

Unique index in the MultibodyTree.


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