Robowflex  v0.1
Making MoveIt Easy
robowflex::Pool::Joblet Class Referenceabstract

Interface class for Pool::Job so template parameters are not needed for the queue. More...

#include <pool.h>

+ Inheritance diagram for robowflex::Pool::Joblet:

Public Member Functions

virtual void execute ()=0
 Execute the underlying function. More...
 
void cancel ()
 Cancels this job. More...
 
bool isCancled () const
 Checks if this job has been cancled. More...
 

Protected Attributes

bool canceled {false}
 Whether the job is cancled or not. More...
 

Detailed Description

Interface class for Pool::Job so template parameters are not needed for the queue.

Definition at line 99 of file pool.h.

Member Function Documentation

◆ cancel()

void Pool::Joblet::cancel ( )

Cancels this job.

Joblet

Definition at line 11 of file pool.cpp.

12 {
13  canceled = true;
14 }
bool canceled
Whether the job is cancled or not.
Definition: pool.h:116

◆ execute()

virtual void robowflex::Pool::Joblet::execute ( )
pure virtual

Execute the underlying function.

Implemented in robowflex::Pool::Job< RT >.

◆ isCancled()

bool Pool::Joblet::isCancled ( ) const

Checks if this job has been cancled.

Returns
True if the job is cancled, false otherwise.

Definition at line 16 of file pool.cpp.

17 {
18  return canceled;
19 }

Member Data Documentation

◆ canceled

bool robowflex::Pool::Joblet::canceled {false}
protected

Whether the job is cancled or not.

Definition at line 116 of file pool.h.


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