Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mbf_abstract_nav::AbstractExecutionBase Class Referenceabstract

#include <abstract_execution_base.h>

Inheritance diagram for mbf_abstract_nav::AbstractExecutionBase:
Inheritance graph
[legend]

Public Member Functions

 AbstractExecutionBase (std::string name)
 
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 void postRun ()
 Optional implementation-specific cleanup function, called right after execution. More...
 
virtual void preRun ()
 Optional implementation-specific setup function, called right before execution. More...
 
virtual bool start ()
 
virtual void stop ()
 
void waitForStateUpdate (boost::chrono::microseconds const &duration)
 

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

◆ AbstractExecutionBase()

mbf_abstract_nav::AbstractExecutionBase::AbstractExecutionBase ( std::string  name)

Definition at line 43 of file abstract_execution_base.cpp.

Member Function Documentation

◆ cancel()

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.

◆ getMessage()

std::string mbf_abstract_nav::AbstractExecutionBase::getMessage ( )

Gets the current plugin execution message.

Definition at line 78 of file abstract_execution_base.cpp.

◆ getName()

std::string mbf_abstract_nav::AbstractExecutionBase::getName ( )

Returns the name of the corresponding plugin.

Definition at line 83 of file abstract_execution_base.cpp.

◆ getOutcome()

uint32_t mbf_abstract_nav::AbstractExecutionBase::getOutcome ( )

Gets the current plugin execution outcome.

Definition at line 73 of file abstract_execution_base.cpp.

◆ join()

void mbf_abstract_nav::AbstractExecutionBase::join ( )

Definition at line 62 of file abstract_execution_base.cpp.

◆ postRun()

virtual void mbf_abstract_nav::AbstractExecutionBase::postRun ( )
inlinevirtual

Optional implementation-specific cleanup function, called right after execution.

Definition at line 93 of file abstract_execution_base.h.

◆ preRun()

virtual void mbf_abstract_nav::AbstractExecutionBase::preRun ( )
inlinevirtual

Optional implementation-specific setup function, called right before execution.

Definition at line 88 of file abstract_execution_base.h.

◆ run()

virtual void mbf_abstract_nav::AbstractExecutionBase::run ( )
protectedpure virtual

◆ start()

bool mbf_abstract_nav::AbstractExecutionBase::start ( )
virtual

Reimplemented in mbf_abstract_nav::AbstractControllerExecution.

Definition at line 48 of file abstract_execution_base.cpp.

◆ stop()

void mbf_abstract_nav::AbstractExecutionBase::stop ( )
virtual

Definition at line 55 of file abstract_execution_base.cpp.

◆ waitForStateUpdate()

void mbf_abstract_nav::AbstractExecutionBase::waitForStateUpdate ( boost::chrono::microseconds const &  duration)

Definition at line 66 of file abstract_execution_base.cpp.

Member Data Documentation

◆ cancel_

bool mbf_abstract_nav::AbstractExecutionBase::cancel_
protected

flag for canceling controlling

Definition at line 105 of file abstract_execution_base.h.

◆ condition_

boost::condition_variable mbf_abstract_nav::AbstractExecutionBase::condition_
protected

condition variable to wake up control thread

Definition at line 99 of file abstract_execution_base.h.

◆ message_

std::string mbf_abstract_nav::AbstractExecutionBase::message_
protected

the last received plugin execution message

Definition at line 111 of file abstract_execution_base.h.

◆ name_

std::string mbf_abstract_nav::AbstractExecutionBase::name_
protected

the plugin name; not the plugin type!

Definition at line 114 of file abstract_execution_base.h.

◆ outcome_

uint32_t mbf_abstract_nav::AbstractExecutionBase::outcome_
protected

the last received plugin execution outcome

Definition at line 108 of file abstract_execution_base.h.

◆ thread_

boost::thread mbf_abstract_nav::AbstractExecutionBase::thread_
protected

the controlling thread object

Definition at line 102 of file abstract_execution_base.h.


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


mbf_abstract_nav
Author(s): Sebastian Pütz
autogenerated on Sat Oct 12 2019 04:02:25