mbf_abstract_nav::AbstractExecutionBase Class Reference

#include <abstract_execution_base.h>

Inheritance diagram for mbf_abstract_nav::AbstractExecutionBase:

Public Member Functions
	AbstractExecutionBase (std::string name, boost::function< void()> setup_fn, boost::function< void()> cleanup_fn)
virtual bool	cancel ()=0
	Cancel the plugin execution. More...
std::string	getMessage ()
	Gets the current plugin execution message. More...
std::string	getName ()
	Returns the name of the corresponding plugin. More...
uint32_t	getOutcome ()
	Gets the current plugin execution outcome. More...
void	join ()
virtual bool	start ()
virtual void	stop ()
void	waitForStateUpdate (boost::chrono::microseconds const &duration)

Public Attributes
boost::function< void()>	cleanup_fn_
	Implementation-specific cleanup function called right after execution; empty on abstract server. More...
boost::function< void()>	setup_fn_
	Implementation-specific setup function called right before execution; empty on abstract server. More...

Protected Member Functions
virtual void	run ()=0

Protected Attributes
bool	cancel_
	flag for canceling controlling More...
boost::condition_variable	condition_
	condition variable to wake up control thread More...
std::string	message_
	the last received plugin execution message More...
std::string	name_
	the plugin name; not the plugin type! More...
uint32_t	outcome_
	the last received plugin execution outcome More...
boost::thread	thread_
	the controlling thread object More...

Detailed Description

Definition at line 50 of file abstract_execution_base.h.

Constructor & Destructor Documentation

mbf_abstract_nav::AbstractExecutionBase::AbstractExecutionBase	(	std::string	name,
		boost::function< void()>	setup_fn,
		boost::function< void()>	cleanup_fn
	)

Definition at line 43 of file abstract_execution_base.cpp.

Member Function Documentation

virtual bool mbf_abstract_nav::AbstractExecutionBase::cancel ( )

pure virtual

Cancel the plugin execution.

Returns

true, if the plugin tries / tried to cancel the computation.

Implemented in mbf_abstract_nav::AbstractPlannerExecution, mbf_abstract_nav::AbstractControllerExecution, and mbf_abstract_nav::AbstractRecoveryExecution.

std::string mbf_abstract_nav::AbstractExecutionBase::getMessage

(

)

Gets the current plugin execution message.

Definition at line 80 of file abstract_execution_base.cpp.

std::string mbf_abstract_nav::AbstractExecutionBase::getName

(

)

Returns the name of the corresponding plugin.

Definition at line 85 of file abstract_execution_base.cpp.

uint32_t mbf_abstract_nav::AbstractExecutionBase::getOutcome

(

)

Gets the current plugin execution outcome.

Definition at line 75 of file abstract_execution_base.cpp.

void mbf_abstract_nav::AbstractExecutionBase::join

(

)

Definition at line 64 of file abstract_execution_base.cpp.

virtual void mbf_abstract_nav::AbstractExecutionBase::run ( )

protectedpure virtual

Implemented in mbf_abstract_nav::AbstractControllerExecution, mbf_abstract_nav::AbstractPlannerExecution, and mbf_abstract_nav::AbstractRecoveryExecution.

bool mbf_abstract_nav::AbstractExecutionBase::start ( )

virtual

Reimplemented in mbf_abstract_nav::AbstractControllerExecution.

Definition at line 50 of file abstract_execution_base.cpp.

void mbf_abstract_nav::AbstractExecutionBase::stop ( )

virtual

Definition at line 57 of file abstract_execution_base.cpp.

void mbf_abstract_nav::AbstractExecutionBase::waitForStateUpdate

(

boost::chrono::microseconds const &

duration

)

Definition at line 68 of file abstract_execution_base.cpp.

Member Data Documentation

bool mbf_abstract_nav::AbstractExecutionBase::cancel_

protected

flag for canceling controlling

Definition at line 108 of file abstract_execution_base.h.

boost::function<void()> mbf_abstract_nav::AbstractExecutionBase::cleanup_fn_

Implementation-specific cleanup function called right after execution; empty on abstract server.

Definition at line 80 of file abstract_execution_base.h.

boost::condition_variable mbf_abstract_nav::AbstractExecutionBase::condition_

protected

condition variable to wake up control thread

Definition at line 102 of file abstract_execution_base.h.

std::string mbf_abstract_nav::AbstractExecutionBase::message_

protected

the last received plugin execution message

Definition at line 114 of file abstract_execution_base.h.

std::string mbf_abstract_nav::AbstractExecutionBase::name_

protected

the plugin name; not the plugin type!

Definition at line 117 of file abstract_execution_base.h.

uint32_t mbf_abstract_nav::AbstractExecutionBase::outcome_

protected

the last received plugin execution outcome

Definition at line 111 of file abstract_execution_base.h.

boost::function<void()> mbf_abstract_nav::AbstractExecutionBase::setup_fn_

Implementation-specific setup function called right before execution; empty on abstract server.

Definition at line 75 of file abstract_execution_base.h.

boost::thread mbf_abstract_nav::AbstractExecutionBase::thread_

protected

the controlling thread object

Definition at line 105 of file abstract_execution_base.h.

---

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

• abstract_execution_base.h
• abstract_execution_base.cpp