ossimJob Class Reference

This is the job callback interface It allows one to attach and listen for different states of the job and if properties have changed. More...

#include <ossimJob.h>

Inheritance diagram for ossimJob:

Public Types
enum	State {   ossimJob_NONE = 0, ossimJob_READY = 1, ossimJob_RUNNING = 2, ossimJob_CANCEL = 4,   ossimJob_FINISHED = 8, ossimJob_ALL = (ossimJob_READY|ossimJob_RUNNING|ossimJob_CANCEL|ossimJob_FINISHED) }
	This is a Bit vector. More...
typedef std::list< std::shared_ptr< ossimJob > >	List

Public Member Functions
	ossimJob ()
virtual void	start ()
	Main entry point to the job. More...
std::shared_ptr< ossimJob >	getSharedFromThis ()
	This is a convenience method to get the shared representation of this pointer. More...
std::shared_ptr< const ossimJob >	getSharedFromThis () const
	This is a convenience method to get the shared representation of this pointer. More...
void	setPercentComplete (double value)
	When the pernet complete is set for the job it will call any callbacks and nofity percentCompleteChanged. More...
void	setPriority (double value)
	sets the priority of the job More...
double	priority () const
virtual void	release ()
	If derived interfaces implement a block this will allow one to release. More...
State	state () const
virtual void	resetState (int value)
	Will clear out the state and the call setState. More...
virtual void	setState (int value, bool on=true)
	Will allow you to set the state of the job. More...
bool	isCanceled () const
virtual void	cancel ()
	Sets the state if the object as cancelled. More...
virtual void	ready ()
	Sets the state if the object as ready. More...
virtual void	running ()
	Sets the state if the object as running. More...
virtual void	finished ()
	Sets the state if the object as finished. More...
bool	isReady () const
bool	isStopped () const
bool	isFinished () const
bool	isRunning () const
void	setCallback (std::shared_ptr< ossimJobCallback > callback)
void	setName (const ossimString &value)
	Sets the name of a job. More...
const ossimString &	name () const
void	setId (const ossimString &value)
const ossimString &	id () const
void	setDescription (const ossimString &value)
const ossimString &	description () const
std::shared_ptr< ossimJobCallback >	callback ()

Protected Member Functions
virtual void	run ()=0
	Abstract method and must be overriden by the base class. More...

Protected Attributes
std::mutex	m_jobMutex
ossimString	m_name
ossimString	m_description
ossimString	m_id
State	m_state
double	m_priority
std::shared_ptr< ossimJobCallback >	m_callback

Detailed Description

This is the job callback interface It allows one to attach and listen for different states of the job and if properties have changed.

#include <ossim/base/Thread.h>
#include <ossim/parallel/ossimJob.h>
// Put your includes here:

// System includes:
#include <memory>
#include <iostream>

class TestJob : public ossimJob
{
public:
   TestJob(){}
protected:
   virtual void run()
   {
      std:cout << "Running Job\n";
      ossim::Thread::sleepInSeconds(2);
      std::cout << "Finished Running Job\n";
   }
};
class MyCallback : public ossimJobCallback
{
public:
   MyCallback(){}
   virtual void started(std::shared_ptr<ossimJob> job)  
   {
      std::cout << "Started job\n";
      ossimJobCallback::started(job);
   }
   virtual void finished(std::shared_ptr<ossimJob> job) 
   {
      std::cout << "Finished job\n";
      ossimJobCallback::finished(job);
   }
};
int main(int argc, char *argv[])
{
   std::shared_ptr<TestJob> job = std::make_shared<TestJob>();
   job->setCallback(std::make_shared<MyCallback>());
   job->start();

   return 0;
}

Definition at line 149 of file ossimJob.h.

Member Typedef Documentation

List

typedef std::list<std::shared_ptr<ossimJob> > ossimJob::List

Definition at line 152 of file ossimJob.h.

Member Enumeration Documentation

State

enum ossimJob::State

This is a Bit vector.

The only value that can be assigned as both active is FINISHED and CANCEL. CANCELED job may not yet be finished. Once the job is finished the Cancel is complete

Enumerator
ossimJob_NONE
ossimJob_READY
ossimJob_RUNNING
ossimJob_CANCEL
ossimJob_FINISHED
ossimJob_ALL

Definition at line 158 of file ossimJob.h.

   {
      ossimJob_NONE     = 0,
      ossimJob_READY    = 1,
      ossimJob_RUNNING  = 2,
      ossimJob_CANCEL   = 4,
      ossimJob_FINISHED = 8,
      ossimJob_ALL = (ossimJob_READY|ossimJob_RUNNING|ossimJob_CANCEL|ossimJob_FINISHED)
   };

Constructor & Destructor Documentation

ossimJob()

ossimJob::ossimJob ( )

inline

Definition at line 168 of file ossimJob.h.

: m_state(ossimJob_READY),  m_priority(0.0) {}

Member Function Documentation

callback()

std::shared_ptr<ossimJobCallback> ossimJob::callback ( )

inline

Returns

the callback

Definition at line 465 of file ossimJob.h.

Referenced by setState().

{return m_callback;}

cancel()

virtual void ossimJob::cancel ( )

inlinevirtual

Sets the state if the object as cancelled.

Definition at line 291 of file ossimJob.h.

   {
      // append the cancel flag to current state
      setState(ossimJob_CANCEL);
   }

description()

const ossimString& ossimJob::description ( ) const

inline

Returns

the desciption of the job

Definition at line 456 of file ossimJob.h.

   {
      std::lock_guard<std::mutex> lock(m_jobMutex);
      return m_description;
   }

finished()

virtual void ossimJob::finished ( )

inlinevirtual

Sets the state if the object as finished.

Definition at line 316 of file ossimJob.h.

Referenced by ossimMultiThreadSequencer::ossimGetTileJob::run().

   {
      int newState = 0;
      {
         // maintain the cancel flag so we can indicate the job has now finished
         std::lock_guard<std::mutex> lock(m_jobMutex);
         newState = ((m_state & ossimJob_CANCEL) | 
            (ossimJob_FINISHED));
      }
      // now reset to the new state
      resetState(newState);
   }

getSharedFromThis() [1/2]

std::shared_ptr<ossimJob> ossimJob::getSharedFromThis ( )

inline

This is a convenience method to get the shared representation of this pointer.

Returns

the shared pointer

Definition at line 185 of file ossimJob.h.

Referenced by setState().

                                              {
      return shared_from_this();
   }

getSharedFromThis() [2/2]

std::shared_ptr<const ossimJob> ossimJob::getSharedFromThis ( ) const

inline

This is a convenience method to get the shared representation of this pointer.

Returns

the shared pointer

Definition at line 195 of file ossimJob.h.

                                                         {
      return shared_from_this();
   }

id()

const ossimString& ossimJob::id ( ) const

inline

Definition at line 428 of file ossimJob.h.

   {
      std::lock_guard<std::mutex> lock(m_jobMutex);
      return m_id;
   }

isCanceled()

bool ossimJob::isCanceled ( ) const

inline

Returns

true if the job is in a cancel state and false otherwise

Definition at line 282 of file ossimJob.h.

   {
      std::lock_guard<std::mutex> lock(m_jobMutex);
      return (m_state & ossimJob_CANCEL);
   }

isFinished()

bool ossimJob::isFinished ( ) const

inline

Returns

true if the state of the object is in a finished state.

Definition at line 350 of file ossimJob.h.

   {
      std::lock_guard<std::mutex> lock(m_jobMutex);
      return (m_state & ossimJob_FINISHED);
   }

isReady()

bool ossimJob::isReady ( ) const

inline

Returns

true if the state of the object is in a ready state.

Definition at line 332 of file ossimJob.h.

   {
      std::lock_guard<std::mutex> lock(m_jobMutex);
      return m_state & ossimJob_READY;
   }

isRunning()

bool ossimJob::isRunning ( ) const

inline

Returns

true if the state of the object is in a running state.

Definition at line 359 of file ossimJob.h.

   {
      std::lock_guard<std::mutex> lock(m_jobMutex);
      return (m_state & ossimJob_RUNNING);
   }

isStopped()

bool ossimJob::isStopped ( ) const

inline

Returns

true if the state of the object is in some kind of stopped state.

Definition at line 341 of file ossimJob.h.

   {
      std::lock_guard<std::mutex> lock(m_jobMutex);
      return (m_state & ossimJob_FINISHED);
   }

name()

const ossimString& ossimJob::name ( ) const

inline

Returns

the name of the job

Definition at line 398 of file ossimJob.h.

   {
      std::lock_guard<std::mutex> lock(m_jobMutex);
      return m_name;
   }

priority()

double ossimJob::priority ( ) const

inline

Definition at line 228 of file ossimJob.h.

   {
      return m_priority;
   }

ready()

virtual void ossimJob::ready ( )

inlinevirtual

Sets the state if the object as ready.

Definition at line 300 of file ossimJob.h.

   {
      resetState(ossimJob_READY);
   }

release()

virtual void ossimJob::release ( )

inlinevirtual

If derived interfaces implement a block this will allow one to release.

Derived classes must override.

Definition at line 237 of file ossimJob.h.

{}

resetState()

virtual void ossimJob::resetState ( int  value )

inlinevirtual

Will clear out the state and the call setState.

Parameters

value

is the state you wish to reset to

Definition at line 253 of file ossimJob.h.

   {
      m_jobMutex.lock();
      if(value != m_state)
      {
         m_state = ossimJob_NONE;
         m_jobMutex.unlock();
         setState(value);
      }
      else 
      {
         m_jobMutex.unlock();
      }

   }

run()

virtual void ossimJob::run ( )

protectedpure virtual

Abstract method and must be overriden by the base class.

The base ossimJob will call run from the start method after setting some variables.

Implemented in ossimFileWalker::ossimFileWalkerJob, RadialProcessorJob, SectorProcessorJob, ossimHlzTool::PatchProcessorJob, and ossimMultiThreadSequencer::ossimGetTileJob.

Referenced by start().

running()

virtual void ossimJob::running ( )

inlinevirtual

Sets the state if the object as running.

Definition at line 308 of file ossimJob.h.

Referenced by ossimMultiThreadSequencer::ossimGetTileJob::run().

   {
      resetState(ossimJob_RUNNING);
   }

setCallback()

void ossimJob::setCallback ( std::shared_ptr< ossimJobCallback >  callback )

inline

Parameters

callback

callback used to call different state of a job

Definition at line 368 of file ossimJob.h.

   {
      std::lock_guard<std::mutex> lock(m_jobMutex);
      m_callback = callback;
   }

setDescription()

void ossimJob::setDescription ( const ossimString &  value )

inline

Definition at line 437 of file ossimJob.h.

   {
      bool changed = false;
      std::shared_ptr<ossimJobCallback> callback;
      {
         std::lock_guard<std::mutex> lock(m_jobMutex);
         changed = value!=m_description;
         m_description = value;
         callback = m_callback;
      }
      if(changed&&callback)
      {
         callback->descriptionChanged(value, getSharedFromThis());
      }
   }

setId()

void ossimJob::setId ( const ossimString &  value )

inline

Definition at line 409 of file ossimJob.h.

   {
      bool changed = false;
      std::shared_ptr<ossimJobCallback> callback;
      {
         std::lock_guard<std::mutex> lock(m_jobMutex);
         changed = value!=m_id;
         m_id = value;
         callback = m_callback;
      }
      if(changed&&callback)
      {
         callback->idChanged(value, getSharedFromThis());
      }
   }

setName()

void ossimJob::setName ( const ossimString &  value )

inline

Sets the name of a job.

Parameters

value

the name of the job

Definition at line 379 of file ossimJob.h.

   {
      bool changed = false;
      std::shared_ptr<ossimJobCallback> callback;
      {
         std::lock_guard<std::mutex> lock(m_jobMutex);
         changed = value!=m_name;
         m_name = value;
         callback = m_callback;
      }
      if(changed&&callback)
      {
         callback->nameChanged(value, getSharedFromThis());
      }
   }

setPercentComplete()

void ossimJob::setPercentComplete ( double  value )

inline

When the pernet complete is set for the job it will call any callbacks and nofity percentCompleteChanged.

percent complete

Definition at line 205 of file ossimJob.h.

   {
      std::lock_guard<std::mutex> lock(m_jobMutex);
      if(m_callback)
      {
         m_callback->percentCompleteChanged(value, getSharedFromThis());
      }
   }

setPriority()

void ossimJob::setPriority ( double  value )

inline

sets the priority of the job

Parameters

value

priority value

Definition at line 219 of file ossimJob.h.

   {
      std::lock_guard<std::mutex> lock(m_jobMutex);
      m_priority = value;
   }

setState()

void ossimJob::setState ( int  value, bool  on = true  )

virtual

Will allow you to set the state of the job.

Parameters

value	is the state you wish to set to
on	will turn the value on if on is true and turn it off otherwise.

Definition at line 14 of file ossimJob.cpp.

References callback(), getSharedFromThis(), m_callback, m_jobMutex, m_state, ossimJob_ALL, ossimJob_CANCEL, ossimJob_FINISHED, ossimJob_READY, and ossimJob_RUNNING.

Referenced by start().

{
   std::shared_ptr<ossimJob> thisShared = getSharedFromThis();

   // we will need to make sure that the state flags are set properly
   // so if you turn on running then you can't have finished or ready turned onturned on
   // but can stil have cancel turned on
   //
   int newState = m_state;
   if(on)
   {
      newState = ((newState | value)&ossimJob_ALL);
   }
   else 
   {
      newState = ((newState & ~value)&ossimJob_ALL);
   }

   int oldState     = 0;
   int currentState = 0;
   std::shared_ptr<ossimJobCallback> callback;

   bool stateChangedFlag = false;
   {
      std::lock_guard<std::mutex> lock(m_jobMutex);
      
      stateChangedFlag = newState != m_state;
      oldState = m_state;
      m_state = static_cast<State>(newState);
      currentState = m_state;
      callback = m_callback;
   }
   
   if(stateChangedFlag&&callback)
   {
      if(!(oldState&ossimJob_READY)&&
         (currentState&ossimJob_READY))
      {
         callback->ready(thisShared);
      }
      else if(!(oldState&ossimJob_RUNNING)&&
              (currentState&ossimJob_RUNNING))
      {
         callback->started(thisShared);
      }
      else if(!(oldState&ossimJob_CANCEL)&&
              (currentState&ossimJob_CANCEL))
      {
         callback->canceled(thisShared);
      }
      else if(!(oldState&ossimJob_FINISHED)&&
              (currentState&ossimJob_FINISHED))
      {
         callback->finished(thisShared);
      }
   }
}

start()

void ossimJob::start ( )

virtual

Main entry point to the job.

It will set the state as running and then call the pure virtual method run. Once completed the job is marked finished only if the job was not canceled.

Classes must override the run method.

See also

run.

Definition at line 4 of file ossimJob.cpp.

References ossimJob_CANCEL, ossimJob_FINISHED, ossimJob_RUNNING, run(), setState(), and state().

{
   setState(ossimJob_RUNNING);
   run();
   if(!(state() & ossimJob_CANCEL))
   {
      setState(ossimJob_FINISHED);
   }
}

state()

State ossimJob::state ( ) const

inline

Returns

the state of the object

Definition at line 242 of file ossimJob.h.

Referenced by start().

   {
      std::lock_guard<std::mutex> lock(m_jobMutex);
      return m_state;
   }

Member Data Documentation

m_callback

std::shared_ptr<ossimJobCallback> ossimJob::m_callback

protected

Definition at line 474 of file ossimJob.h.

Referenced by setState().

m_description

ossimString ossimJob::m_description

protected

Definition at line 470 of file ossimJob.h.

m_id

ossimString ossimJob::m_id

protected

Definition at line 471 of file ossimJob.h.

m_jobMutex

std::mutex ossimJob::m_jobMutex

mutableprotected

Definition at line 468 of file ossimJob.h.

Referenced by setState().

m_name

ossimString ossimJob::m_name

protected

Definition at line 469 of file ossimJob.h.

m_priority

double ossimJob::m_priority

protected

Definition at line 473 of file ossimJob.h.

m_state

State ossimJob::m_state

protected

Definition at line 472 of file ossimJob.h.

Referenced by setState().

---

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

• ossimJob.h
• ossimJob.cpp