OpenWalker Project
Documentation of the ROS Packages
Public Types | Public Member Functions | List of all members
ow_core::AngularPositionRef< _Derived > Class Template Reference

The AngularPositionRef class. More...

#include <angular_position_ref.h>

Inheritance diagram for ow_core::AngularPositionRef< _Derived >:
ow_core::QuaternionRef< _Derived > Eigen::QuaternionRef< _Derived >

Public Types

typedef _Derived Derived
 
typedef QuaternionRef< Derived > Base
 
- Public Types inherited from ow_core::QuaternionRef< _Derived >
typedef _Derived Derived
 
typedef Eigen::QuaternionRef< Derived > Base
 
- Public Types inherited from Eigen::QuaternionRef< _Derived >
typedef _Derived Derived
 
typedef Eigen::QuaternionBase< QuaternionRef< _Derived > > Base
 
typedef Eigen::internal::traits< QuaternionRef >::Coefficients Coefficients
 

Public Member Functions

 AngularPositionRef (Derived &ref, int startRow=0, int startCol=0)
 Default Constructor. More...
 
void operator= (const tf::Quaternion &q)
 Assignment of tf::Quaternion. More...
 
void operator= (const geometry_msgs::Quaternion &q)
 Assignment of geometry_msgs::Quaternion. More...
 
void operator= (const tf::Matrix3x3 &other)
 Assignment of tf::Matrix3x3.
 
 operator tf::Quaternion () const
 Conversion to tf::Quaternion.
 
 operator geometry_msgs::Quaternion () const
 Conversion to geometry_msgs::Quaternion.
 
 operator tf::Matrix3x3 () const
 Conversion to tf::Matrix3x3.
 
tf::Quaternion toQuaternionTF ()
 Conversion to tf::Quaternion.
 
geometry_msgs::Quaternion toQuaternionMsg ()
 Conversion to geometry_msgs::Quaternion.
 
tf::Matrix3x3 toMatrixTF ()
 Conversion to tf::Matrix3x3.
 
- Public Member Functions inherited from ow_core::QuaternionRef< _Derived >
 QuaternionRef (Derived &ref, int startRow=0, int startCol=0)
 Default Constructor. More...
 
- Public Member Functions inherited from Eigen::QuaternionRef< _Derived >
 QuaternionRef (Derived &ref, int startRow=0, int startCol=0)
 Default Constructor. More...
 
Coefficients & coeffs ()
 Get quaternion coefficients. More...
 
const Coefficients & coeffs () const
 Get quaternion coefficients. More...
 
std::string toString () const
 Conversion to std::string.
 

Additional Inherited Members

- Protected Attributes inherited from Eigen::QuaternionRef< _Derived >
Coefficients coeffs_
 The quaternion coefficients in a Eigen::Block.
 

Detailed Description

template<typename _Derived>
class ow_core::AngularPositionRef< _Derived >

The AngularPositionRef class.

The AngularPosition is of type Eigen::Quaternion and is represented by the math symbol $\mathbf{Q}$.

References the data of another Eigen type class via Eigen:Block.

We need this special type to get the behavior of Eigen::Quaternion and add specific new functionality.

Constructor & Destructor Documentation

template<typename _Derived>
ow_core::AngularPositionRef< _Derived >::AngularPositionRef ( Derived &  ref,
int  startRow = 0,
int  startCol = 0 
)
inlineexplicit

Default Constructor.

Parameters
refthe reference to storage Eigen object to access the elements of the quaternion via Eigen::Block.
startRowthe start index of the row for Eigen::Block.
startColthe start index of the column for Eigen::Block.

Member Function Documentation

template<typename _Derived>
void ow_core::AngularPositionRef< _Derived >::operator= ( const tf::Quaternion &  q)
inline

Assignment of tf::Quaternion.

Todo:
Maybe call a static converion function.
template<typename _Derived>
void ow_core::AngularPositionRef< _Derived >::operator= ( const geometry_msgs::Quaternion &  q)
inline

Assignment of geometry_msgs::Quaternion.

Bug:
This is a test bug to test the listing. Remove!

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