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

The VectorDof class. More...

#include <vector_dof.h>

Inheritance diagram for ow_core::VectorDof< _Scalar, _Rows >:
ow_core::JointAcceleration< _Scalar, _Rows > ow_core::JointEffort< _Scalar, _Rows > ow_core::JointPosition< _Scalar, _Rows > ow_core::JointVelocity< _Scalar, _Rows >

Public Types

enum  { Rows = _Rows }
 
typedef _Scalar Scalar
 
typedef Eigen::Matrix< Scalar, Rows, 1 > Base
 

Public Member Functions

 VectorDof ()
 Default Constructor.
 
template<typename OtherDerived >
 VectorDof (const Eigen::EigenBase< OtherDerived > &other)
 Copy constructor. More...
 
VectorDofsetConstant (const Scalar &value)
 
VectorDofsetLinSpaced (const Scalar &low, const Scalar &high)
 
VectorDofsetZero ()
 
VectorDofsetOnes ()
 
VectorDofsetRandom ()
 
std::string toString () const
 Conversion to std::string.
 

Static Public Member Functions

static Base::ConstantReturnType Zero ()
 Returns an expression where all coefficients equal zero. More...
 
static Base::ConstantReturnType Ones ()
 Returns an expression where all coefficients equal one.
 
static Base::ConstantReturnType Constant (const Scalar &value)
 Returns an expression where all coefficients equal the given value.
 
static const Base::RandomReturnType Random ()
 Returns an expression where all coefficients are random.
 
static const Base::BasisReturnType Unit (typename Base::Index i)
 Returns an expression where all coefficients represent the i-th basis vector.
 

Detailed Description

template<typename _Scalar, int _Rows>
class ow_core::VectorDof< _Scalar, _Rows >

The VectorDof class.

The VectorDof is of type Eigen::Matrix.

Constructor & Destructor Documentation

template<typename _Scalar, int _Rows>
template<typename OtherDerived >
ow_core::VectorDof< _Scalar, _Rows >::VectorDof ( const Eigen::EigenBase< OtherDerived > &  other)
inline

Copy constructor.

This copy constructor not only works with Eigen matrices but also with their expressions.

Member Function Documentation

template<typename _Scalar, int _Rows>
static Base::ConstantReturnType ow_core::VectorDof< _Scalar, _Rows >::Zero ( )
inlinestatic

Returns an expression where all coefficients equal zero.

Todo:
Change all Zero() etc. functions of ow types to use constant expressions, if necessary.

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