OSSIM - Open Source Software Image Map  Version 1.9.0 (20180803)
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ossimFileWalker::ossimFileWalkerJob Class Reference

Private ossimJob class. More...

Inheritance diagram for ossimFileWalker::ossimFileWalkerJob:
ossimJob

Public Member Functions

 ossimFileWalkerJob (ossimFileProcessorInterface *fpi, const ossimFilename &file)
 Constructor that takes file processor pointer and file. More...
 
- Public Member Functions inherited from ossimJob
 ossimJob ()
 
virtual void start ()
 Main entry point to the job. More...
 
std::shared_ptr< ossimJobgetSharedFromThis ()
 This is a convenience method to get the shared representation of this pointer. More...
 
std::shared_ptr< const ossimJobgetSharedFromThis () 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 ossimStringname () const
 
void setId (const ossimString &value)
 
const ossimStringid () const
 
void setDescription (const ossimString &value)
 
const ossimStringdescription () const
 
std::shared_ptr< ossimJobCallbackcallback ()
 

Protected Member Functions

virtual void run ()
 Defines pure virtual ossimJob::start. More...
 

Private Attributes

ossimFileProcessorInterfacem_fileProcessor
 
ossimFilename m_file
 

Additional Inherited Members

- Public Types inherited from ossimJob
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
 
- Protected Attributes inherited from ossimJob
std::mutex m_jobMutex
 
ossimString m_name
 
ossimString m_description
 
ossimString m_id
 
State m_state
 
double m_priority
 
std::shared_ptr< ossimJobCallbackm_callback
 

Detailed Description

Private ossimJob class.

Definition at line 151 of file ossimFileWalker.h.

Constructor & Destructor Documentation

◆ ossimFileWalkerJob()

ossimFileWalker::ossimFileWalkerJob::ossimFileWalkerJob ( ossimFileProcessorInterface fpi,
const ossimFilename file 
)

Constructor that takes file processor pointer and file.

Parameters
fpiossimFileProcessorInterface pointer
fileThe file to process.

Definition at line 494 of file ossimFileWalker.cpp.

497  : m_fileProcessor( fpi ),
498  m_file( file )
499 {
500 }
ossimFileProcessorInterface * m_fileProcessor

Member Function Documentation

◆ run()

void ossimFileWalker::ossimFileWalkerJob::run ( )
protectedvirtual

Defines pure virtual ossimJob::start.

This executes the call to m_processFileCallBackPtr.

Implements ossimJob.

Definition at line 502 of file ossimFileWalker.cpp.

References ossimFileWalker::m_fileProcessor, and ossimFileProcessorInterface::processFile().

503 {
504  if ( m_fileProcessor && m_file.size() )
505  {
507  }
508 }
ossimFileProcessorInterface * m_fileProcessor
std::string::size_type size() const
Definition: ossimString.h:405
virtual void processFile(const ossimFilename &file)=0
Pure virtual processFile method.

Member Data Documentation

◆ m_file

ossimFilename ossimFileWalker::ossimFileWalkerJob::m_file
private

Definition at line 172 of file ossimFileWalker.h.

◆ m_fileProcessor

ossimFileProcessorInterface* ossimFileWalker::ossimFileWalkerJob::m_fileProcessor
private

Definition at line 171 of file ossimFileWalker.h.


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