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

The MatrixRef class. More...

#include <matrix_ref.h>

Inheritance diagram for ow_core::MatrixRef< _Derived, _Rows, _Cols >:

Public Types

enum  { Rows = _Rows, Cols = _Cols }
 
typedef _Derived Derived
 
typedef Eigen::Block< Derived, Rows, Cols > Base
 

Public Member Functions

 MatrixRef (Derived &ref, int startRow=0, int startCol=0)
 Default Constructor. More...
 
std::string toString () const
 Conversion to std::string. More...
 

Detailed Description

template<typename _Derived, int _Rows, int _Cols>
class ow_core::MatrixRef< _Derived, _Rows, _Cols >

The MatrixRef class.

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

We need this special type to get the behavior of Eigen::Matrix when defining new references.

Constructor & Destructor Documentation

template<typename _Derived, int _Rows, int _Cols>
ow_core::MatrixRef< _Derived, _Rows, _Cols >::MatrixRef ( 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, int _Rows, int _Cols>
std::string ow_core::MatrixRef< _Derived, _Rows, _Cols >::toString ( ) const
inline

Conversion to std::string.

Returns
the string for this type.

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