Aikido
aikido::statespace::SE2::State Class Reference

#include <aikido/statespace/SE2.hpp>

Inheritance diagram for aikido::statespace::SE2::State:
aikido::statespace::StateSpace::State

Public Types

using Isometry2d = Eigen::Transform< double, 2, Eigen::Isometry, Eigen::DontAlign >
 

Public Member Functions

 State ()
 Constructs the identity element. More...
 
 ~State ()=default
 
 State (const Isometry2d &_transform)
 Constructs the state from an Eigen transformation object. More...
 
void setIsometry (const Isometry2d &_transform)
 Sets value to an Eigen transfomation object. More...
 
const Isometry2dgetIsometry () const
 Gets value as an Eigen transformation object. More...
 

Private Attributes

Isometry2d mTransform
 

Friends

class SE2
 

Additional Inherited Members

- Protected Member Functions inherited from aikido::statespace::StateSpace::State
 State ()=default
 This is a base class that should only only be used in derived classes. More...
 
 ~State ()=default
 It is unsafe to call this, since it is a non-virtual destructor. More...
 

Member Typedef Documentation

◆ Isometry2d

using aikido::statespace::SE2::State::Isometry2d = Eigen::Transform<double, 2, Eigen::Isometry, Eigen::DontAlign>

Constructor & Destructor Documentation

◆ State() [1/2]

aikido::statespace::SE2::State::State ( )

Constructs the identity element.

◆ ~State()

aikido::statespace::SE2::State::~State ( )
default

◆ State() [2/2]

aikido::statespace::SE2::State::State ( const Isometry2d _transform)
explicit

Constructs the state from an Eigen transformation object.

Parameters
_transformEigen transformation

Member Function Documentation

◆ getIsometry()

const Isometry2d& aikido::statespace::SE2::State::getIsometry ( ) const

Gets value as an Eigen transformation object.

Returns
Eigen trasnformation

◆ setIsometry()

void aikido::statespace::SE2::State::setIsometry ( const Isometry2d _transform)

Sets value to an Eigen transfomation object.

Parameters
_transformEigen transformation

Friends And Related Function Documentation

◆ SE2

friend class SE2
friend

Member Data Documentation

◆ mTransform

Isometry2d aikido::statespace::SE2::State::mTransform
private