Kindr
Kinematics and Dynamics for Robotics
kindr::WrenchBase< Derived_ > Class Template Reference

#include <WrenchBase.hpp>

Public Member Functions

 WrenchBase ()=default
 Default constructor. More...
 
 WrenchBase (const Derived_ &)=delete
 Constructor from derived. This constructor has been deleted because the abstract class does not contain any data. More...
 
 operator Derived_ & ()
 Gets the derived. More...
 
 operator const Derived_ & () const
 Gets the derived. More...
 
const Derived_ & derived () const
 Gets the derived. More...
 
Derived_ & setZero ()
 Sets wrench to zero. More...
 

Detailed Description

template<typename Derived_>
class kindr::WrenchBase< Derived_ >

Definition at line 40 of file WrenchBase.hpp.

Constructor & Destructor Documentation

◆ WrenchBase() [1/2]

template<typename Derived_>
kindr::WrenchBase< Derived_ >::WrenchBase ( )
default

Default constructor.

Creates a wrench with all values set to zero.

◆ WrenchBase() [2/2]

template<typename Derived_>
kindr::WrenchBase< Derived_ >::WrenchBase ( const Derived_ &  )
delete

Constructor from derived. This constructor has been deleted because the abstract class does not contain any data.

Member Function Documentation

◆ derived()

template<typename Derived_>
const Derived_& kindr::WrenchBase< Derived_ >::derived ( ) const
inline

Gets the derived.

(only for advanced users)

Returns
the derived time derivative of a pose

Definition at line 76 of file WrenchBase.hpp.

◆ operator const Derived_ &()

template<typename Derived_>
kindr::WrenchBase< Derived_ >::operator const Derived_ & ( ) const
inline

Gets the derived.

(only for advanced users)

Returns
the derived time derivative of a pose

Definition at line 67 of file WrenchBase.hpp.

◆ operator Derived_ &()

template<typename Derived_>
kindr::WrenchBase< Derived_ >::operator Derived_ & ( )
inline

Gets the derived.

(only for advanced users)

Returns
the derived time derivative of a pose

Definition at line 58 of file WrenchBase.hpp.

◆ setZero()

template<typename Derived_>
Derived_& kindr::WrenchBase< Derived_ >::setZero ( )

Sets wrench to zero.

Returns
reference

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