ossimJobCallback 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 ossimJobCallback:

Public Member Functions
	ossimJobCallback (std::shared_ptr< ossimJobCallback > nextCallback=0)
virtual void	ready (std::shared_ptr< ossimJob > job)
virtual void	started (std::shared_ptr< ossimJob > job)
virtual void	finished (std::shared_ptr< ossimJob > job)
virtual void	canceled (std::shared_ptr< ossimJob > job)
virtual void	nameChanged (const ossimString &name, std::shared_ptr< ossimJob > job)
virtual void	descriptionChanged (const ossimString &description, std::shared_ptr< ossimJob > job)
virtual void	idChanged (const ossimString &id, std::shared_ptr< ossimJob > job)
virtual void	percentCompleteChanged (double percentValue, std::shared_ptr< ossimJob > job)
void	setCallback (std::shared_ptr< ossimJobCallback > c)
std::shared_ptr< ossimJobCallback >	callback ()

Protected Attributes
std::shared_ptr< ossimJobCallback >	m_nextCallback

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 68 of file ossimJob.h.

Constructor & Destructor Documentation

ossimJobCallback()

ossimJobCallback::ossimJobCallback ( std::shared_ptr< ossimJobCallback >  nextCallback = 0 )

inline

Definition at line 71 of file ossimJob.h.

:m_nextCallback(nextCallback){}

Member Function Documentation

callback()

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

inline

Definition at line 91 of file ossimJob.h.

{return m_nextCallback;}

canceled()

virtual void ossimJobCallback::canceled ( std::shared_ptr< ossimJob >  job )

inlinevirtual

Reimplemented in ossimFileWalker::ossimFileWalkerJobCallback.

Definition at line 76 of file ossimJob.h.

Referenced by ossimFileWalker::ossimFileWalkerJobCallback::canceled().

{if(m_nextCallback) m_nextCallback->canceled(job);}

descriptionChanged()

virtual void ossimJobCallback::descriptionChanged ( const ossimString &  description, std::shared_ptr< ossimJob >  job  )

inlinevirtual

Definition at line 81 of file ossimJob.h.

   {if(m_nextCallback) m_nextCallback->descriptionChanged(description, job);}

finished()

virtual void ossimJobCallback::finished ( std::shared_ptr< ossimJob >  job )

inlinevirtual

Reimplemented in ossimFileWalker::ossimFileWalkerJobCallback, and ossimMultiThreadSequencer::ossimGetTileCallback.

Definition at line 75 of file ossimJob.h.

Referenced by ossimFileWalker::ossimFileWalkerJobCallback::finished().

{if(m_nextCallback) m_nextCallback->finished(job);}

idChanged()

virtual void ossimJobCallback::idChanged ( const ossimString &  id, std::shared_ptr< ossimJob >  job  )

inlinevirtual

Definition at line 84 of file ossimJob.h.

   {if(m_nextCallback) m_nextCallback->idChanged(id, job);}

nameChanged()

virtual void ossimJobCallback::nameChanged ( const ossimString &  name, std::shared_ptr< ossimJob >  job  )

inlinevirtual

Definition at line 78 of file ossimJob.h.

   {if(m_nextCallback) m_nextCallback->nameChanged(name, job);}

percentCompleteChanged()

virtual void ossimJobCallback::percentCompleteChanged ( double  percentValue, std::shared_ptr< ossimJob >  job  )

inlinevirtual

Definition at line 87 of file ossimJob.h.

   {if(m_nextCallback) m_nextCallback->percentCompleteChanged(percentValue, job);}

ready()

virtual void ossimJobCallback::ready ( std::shared_ptr< ossimJob >  job )

inlinevirtual

Definition at line 73 of file ossimJob.h.

{if(m_nextCallback) m_nextCallback->ready(job);   }

setCallback()

void ossimJobCallback::setCallback ( std::shared_ptr< ossimJobCallback >  c )

inline

Definition at line 90 of file ossimJob.h.

{m_nextCallback = c;}

started()

virtual void ossimJobCallback::started ( std::shared_ptr< ossimJob >  job )

inlinevirtual

Reimplemented in ossimFileWalker::ossimFileWalkerJobCallback.

Definition at line 74 of file ossimJob.h.

Referenced by ossimFileWalker::ossimFileWalkerJobCallback::started().

{if(m_nextCallback) m_nextCallback->started(job); }

Member Data Documentation

m_nextCallback

std::shared_ptr<ossimJobCallback> ossimJobCallback::m_nextCallback

protected

Definition at line 94 of file ossimJob.h.

---

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

• ossimJob.h