Eigen::QuaternionRef< _Derived > Class Template Reference

The QuaternionRef class. More...

#include <quaternion_ref.h>

Inheritance diagram for Eigen::QuaternionRef< _Derived >:

Public Types
typedef _Derived	Derived
typedef Eigen::QuaternionBase< QuaternionRef< _Derived > >	Base
typedef Eigen::internal::traits< QuaternionRef >::Coefficients	Coefficients

Public Member Functions
	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.

Protected Attributes
Coefficients	coeffs_
	The quaternion coefficients in a Eigen::Block.

Detailed Description

template<typename _Derived>
class Eigen::QuaternionRef< _Derived >

The QuaternionRef class.

This class provides access to the quaternion elements within another Eigen type class. This Eigen type class has to provide/support the Eigen::Block access.

We need this special type to get the behavior of Eigen::Quaternion in references where the source of the Quaternion elements is not a Quaternion itsself.

Constructor & Destructor Documentation

template<typename _Derived>

Eigen::QuaternionRef< _Derived >::QuaternionRef ( Derived &  ref, int  startRow = 0, int  startCol = 0  )

inline

Default Constructor.

Parameters

ref	the reference to storage Eigen object to access the elements of the quaternion via Eigen::Block.
startRow	the start index of the row for Eigen::Block.
startCol	the start index of the column for Eigen::Block.

Member Function Documentation

template<typename _Derived>

Coefficients& Eigen::QuaternionRef< _Derived >::coeffs ( )

inline

Get quaternion coefficients.

This function is used internally by Eigen to get the coefficients for the Quaternion functionalities provided by Eigen::QuaternionBase.

template<typename _Derived>

const Coefficients& Eigen::QuaternionRef< _Derived >::coeffs ( ) const

inline

Get quaternion coefficients.

This function is used internally by Eigen to get the coefficients for the Quaternion functionalities provided by Eigen::QuaternionBase.

---

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

• /home/dean/ros/workspaces/ow_test_ws/src/ow_core/include/ow_core/Eigen/quaternion_ref.h