aikido::planner::WorldStateSaver Class Reference

RAII class to save and restore a World's state. More...

#include <aikido/planner/WorldStateSaver.hpp>

Public Types
enum	Options { CONFIGURATIONS = 1 << 0 }
	Options to specify what WorldStateSaver should save. More...

Public Member Functions
	WorldStateSaver (World *world, int options=CONFIGURATIONS)
	Construct a WorldStateSaver and save the current state of the World. More...
virtual	~WorldStateSaver ()

Private Attributes
World *	mWorld
	World to save the state of. More...
int	mOptions
	Options to specify what should be saved. More...
World::State	mWorldState
	Saved state. More...

Detailed Description

RAII class to save and restore a World's state.

Member Enumeration Documentation

Options

enum aikido::planner::WorldStateSaver::Options

Options to specify what WorldStateSaver should save.

Enumerator
CONFIGURATIONS

Constructor & Destructor Documentation

WorldStateSaver()

aikido::planner::WorldStateSaver::WorldStateSaver ( World *  world, int  options = CONFIGURATIONS  )

explicit

Construct a WorldStateSaver and save the current state of the World.

This state will be restored when WorldStateSaver is destructed.

Parameters

[in]	world	World to save state from and restore to.
[in]	options	Options to specify what should be saved

~WorldStateSaver()

virtual aikido::planner::WorldStateSaver::~WorldStateSaver ( )

virtual

Member Data Documentation

mOptions

int aikido::planner::WorldStateSaver::mOptions

private

Options to specify what should be saved.

mWorld

World* aikido::planner::WorldStateSaver::mWorld

private

World to save the state of.

mWorldState

World::State aikido::planner::WorldStateSaver::mWorldState

private

Saved state.