aikido::statespace::ScopedState< _Handle > Class Template Reference

CRTP RAII wrapper for a StateHandle. More...

#include <ScopedState.hpp>

Inheritance diagram for aikido::statespace::ScopedState< _Handle >:

Public Types
using	Handle = _Handle

Public Member Functions
	ScopedState (const StateSpace *_space)
	Construct a ScopedState by allocating a new state in _space. More...
	ScopedState (const ScopedState &)=delete
ScopedState &	operator= (const ScopedState &)=delete
	ScopedState (ScopedState &&)=default
ScopedState &	operator= (ScopedState &&)=default
ScopedState	clone () const
	Creates an identical clone of the state this ScopedState handles.

Detailed Description

template<class _Handle>
class aikido::statespace::ScopedState< _Handle >

CRTP RAII wrapper for a StateHandle.

The constructor of ScopedState allocates a state and the destructor destroys it.

Template Parameters

_Handle

StateHandle class being wrapped.

Constructor & Destructor Documentation

ScopedState()

template<class Handle >

aikido::statespace::ScopedState< Handle >::ScopedState ( const StateSpace *  _space )

explicit

Construct a ScopedState by allocating a new state in _space.

This state will be freed when ScopedState is destructed.

Parameters

_space

state

---

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

• include/aikido/statespace/ScopedState.hpp
• include/aikido/statespace/detail/ScopedState-impl.hpp