Drake
FrameKinematicsVector< KinematicsValue > Class Template Reference

A FrameKinematicsVector associates a std::vector with a geometry source. More...

#include <drake/geometry/frame_kinematics_vector.h>

Public Member Functions

 FrameKinematicsVector (SourceId source_id)
 Constructs an empty vector. More...
 
 FrameKinematicsVector (SourceId source_id, const std::vector< KinematicsValue > &values)
 Copy constructs from a std::vector of KinematicsValue type. More...
 
 FrameKinematicsVector (SourceId source_id, std::vector< KinematicsValue > &&values)
 Move constructs from a std::vector of KinematicsValue type. More...
 
SourceId get_source_id () const
 
const std::vector< KinematicsValue > & vector () const
 
std::vector< KinematicsValue > & mutable_vector ()
 
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
 FrameKinematicsVector (const FrameKinematicsVector &)=default
 
FrameKinematicsVectoroperator= (const FrameKinematicsVector &)=default
 
 FrameKinematicsVector (FrameKinematicsVector &&)=default
 
FrameKinematicsVectoroperator= (FrameKinematicsVector &&)=default
 

Detailed Description

template<class KinematicsValue>
class drake::geometry::FrameKinematicsVector< KinematicsValue >

A FrameKinematicsVector associates a std::vector with a geometry source.

It serves as the basis of FramePoseVector, FrameVelocityVector, and FrameAccelerationVector. Geometry sources report the kinematics values for their registered frame through these classes.

The FrameKinematicsVector must be constructed with the source's SourceId and then one kinematics value (e.g., pose) must be added to the underlying vector for each registered frame. The values are interpreted by the order of FrameId values in the corresponding FrameIdVector; the iᵗʰ value is attributed to the frame identified by the iᵗʰ FrameId in the FrameIdVector.

Constructor & Destructor Documentation

FrameKinematicsVector ( const FrameKinematicsVector< KinematicsValue > &  )
default
FrameKinematicsVector ( FrameKinematicsVector< KinematicsValue > &&  )
default
FrameKinematicsVector ( SourceId  source_id)
explicit

Constructs an empty vector.

FrameKinematicsVector ( SourceId  source_id,
const std::vector< KinematicsValue > &  values 
)

Copy constructs from a std::vector of KinematicsValue type.

FrameKinematicsVector ( SourceId  source_id,
std::vector< KinematicsValue > &&  values 
)

Move constructs from a std::vector of KinematicsValue type.

Member Function Documentation

SourceId get_source_id ( ) const
inline

Here is the caller graph for this function:

std::vector<KinematicsValue>& mutable_vector ( )
inline

Here is the caller graph for this function:

FrameKinematicsVector& operator= ( FrameKinematicsVector< KinematicsValue > &&  )
default
FrameKinematicsVector& operator= ( const FrameKinematicsVector< KinematicsValue > &  )
default
const std::vector<KinematicsValue>& vector ( ) const
inline

Here is the caller graph for this function:


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