ossimProcessInterface Class Reference

#include <ossimProcessInterface.h>

Inheritance diagram for ossimProcessInterface:

Public Types
enum	ossimProcessStatus {   PROCESS_STATUS_UNKNOWN = 0, PROCESS_STATUS_EXECUTING = 1, PROCESS_STATUS_ABORTED = 2, PROCESS_STATUS_ABORT_REQUEST = 3,   PROCESS_STATUS_NOT_EXECUTING = 4 }

Public Member Functions
	ossimProcessInterface ()
virtual	~ossimProcessInterface ()
virtual ossimObject *	getObject ()=0
virtual const ossimObject *	getObject () const =0
virtual bool	execute ()=0
virtual void	abort ()
bool	needsAborting () const
bool	isAbortRequested () const
bool	isAborted () const
bool	isExecuting () const
ossimProcessStatus	getProcessStatus () const
virtual void	setProcessStatus (ossimProcessStatus processStatus)
virtual double	getPercentComplete () const
virtual void	setPercentComplete (double percentComplete)
virtual ossimListenerManager *	getManager ()
void	enableEvents ()
void	disableEvents ()
void	setCurrentMessage (const ossimString &message)
virtual std::ostream &	print (std::ostream &out) const

Protected Attributes
double	thePercentComplete
ossimProcessStatus	theProcessStatus
ossimString	theMessage
bool	theEventFlag

Friends
OSSIM_DLL std::ostream &	operator<< (std::ostream &out, const ossimProcessInterface &data)

Detailed Description

Definition at line 21 of file ossimProcessInterface.h.

Member Enumeration Documentation

ossimProcessStatus

enum ossimProcessInterface::ossimProcessStatus

Enumerator
PROCESS_STATUS_UNKNOWN
PROCESS_STATUS_EXECUTING
PROCESS_STATUS_ABORTED
PROCESS_STATUS_ABORT_REQUEST
PROCESS_STATUS_NOT_EXECUTING

Definition at line 25 of file ossimProcessInterface.h.

   {
      PROCESS_STATUS_UNKNOWN       = 0,
      PROCESS_STATUS_EXECUTING     = 1,
      PROCESS_STATUS_ABORTED       = 2,
      PROCESS_STATUS_ABORT_REQUEST = 3,
      PROCESS_STATUS_NOT_EXECUTING = 4
   };

Constructor & Destructor Documentation

ossimProcessInterface()

ossimProcessInterface::ossimProcessInterface

(

)

Definition at line 20 of file ossimProcessInterface.cpp.

   :thePercentComplete(0.0),
    theProcessStatus(PROCESS_STATUS_NOT_EXECUTING),
    theMessage(""),
    theEventFlag(true)
{
}

~ossimProcessInterface()

ossimProcessInterface::~ossimProcessInterface ( )

virtual

Definition at line 28 of file ossimProcessInterface.cpp.

{
}

Member Function Documentation

abort()

void ossimProcessInterface::abort ( )

virtual

Reimplemented in ossimAtbController, ossimHistogramWriter, and ossimChipProcTool.

Definition at line 32 of file ossimProcessInterface.cpp.

References PROCESS_STATUS_ABORT_REQUEST, PROCESS_STATUS_EXECUTING, setProcessStatus(), and theProcessStatus.

Referenced by ossimChipProcTool::abort(), ossimHistogramWriter::abort(), and ossimChipperUtil::abort().

{
   if(theProcessStatus == PROCESS_STATUS_EXECUTING)
   {
      setProcessStatus(PROCESS_STATUS_ABORT_REQUEST);
   }
}

disableEvents()

void ossimProcessInterface::disableEvents

(

)

Definition at line 101 of file ossimProcessInterface.cpp.

References theEventFlag.

{
   theEventFlag = false;
}

enableEvents()

void ossimProcessInterface::enableEvents

(

)

Definition at line 96 of file ossimProcessInterface.cpp.

References theEventFlag.

{
   theEventFlag = true;
}

execute()

virtual bool ossimProcessInterface::execute ( )

pure virtual

Implemented in ossimImageFileWriter, ossimOverviewBuilderBase, ossimAtbController, ossimVertexExtractor, ossimChipProcTool, ossimTiffOverviewBuilder, ossimGdalOverviewBuilder, ossimMetadataFileWriter, ossimSubImageTool, ossimImageHistogramSource, ossimViewshedTool, ossimKakaduNitfOverviewBuilder, ossimHdf5Tool, ossimShorelineTool, ossimHistogramWriter, ossimHlzTool, ossimPotraceTool, ossimBandMergeTool, ossimEquationUtil, and ossimRegTool.

getManager()

ossimListenerManager * ossimProcessInterface::getManager ( )

virtual

Reimplemented in ossimChipProcTool, and ossimEquationUtil.

Definition at line 91 of file ossimProcessInterface.cpp.

References getObject(), and PTR_CAST.

Referenced by setCurrentMessage(), and setPercentComplete().

{
   return PTR_CAST(ossimListenerManager, getObject());
}

getObject() [1/2]

virtual ossimObject* ossimProcessInterface::getObject ( )

pure virtual

Implemented in ossimTiffOverviewBuilder, ossimGdalOverviewBuilder, ossimKakaduNitfOverviewBuilder, ossimChipProcTool, ossimAtbController, ossimMetadataFileWriter, ossimImageFileWriter, ossimHistogramWriter, ossimVertexExtractor, ossimEquationUtil, and ossimImageHistogramSource.

Referenced by getManager(), setCurrentMessage(), and setPercentComplete().

getObject() [2/2]

virtual const ossimObject* ossimProcessInterface::getObject ( ) const

pure virtual

Implemented in ossimTiffOverviewBuilder, ossimGdalOverviewBuilder, ossimKakaduNitfOverviewBuilder, ossimChipProcTool, ossimAtbController, ossimMetadataFileWriter, ossimImageFileWriter, ossimHistogramWriter, ossimVertexExtractor, ossimEquationUtil, and ossimImageHistogramSource.

getPercentComplete()

double ossimProcessInterface::getPercentComplete ( ) const

virtual

Definition at line 71 of file ossimProcessInterface.cpp.

References thePercentComplete.

{
   return thePercentComplete;
}

getProcessStatus()

ossimProcessInterface::ossimProcessStatus ossimProcessInterface::getProcessStatus

(

)

const

Definition at line 61 of file ossimProcessInterface.cpp.

References theProcessStatus.

{
   return theProcessStatus;
}

isAborted()

bool ossimProcessInterface::isAborted

(

)

const

Definition at line 50 of file ossimProcessInterface.cpp.

References PROCESS_STATUS_ABORTED, and theProcessStatus.

Referenced by ossimChipProcTool::execute(), needsAborting(), and ossimHistogramWriter::writeHistogram().

{
   return (theProcessStatus==PROCESS_STATUS_ABORTED);
}

isAbortRequested()

bool ossimProcessInterface::isAbortRequested

(

)

const

Definition at line 45 of file ossimProcessInterface.cpp.

References PROCESS_STATUS_ABORT_REQUEST, and theProcessStatus.

Referenced by needsAborting().

{
   return (theProcessStatus == PROCESS_STATUS_ABORT_REQUEST);
}

isExecuting()

bool ossimProcessInterface::isExecuting

(

)

const

Definition at line 55 of file ossimProcessInterface.cpp.

References PROCESS_STATUS_ABORT_REQUEST, PROCESS_STATUS_EXECUTING, and theProcessStatus.

{
   return ((theProcessStatus==PROCESS_STATUS_EXECUTING)||
           (theProcessStatus==PROCESS_STATUS_ABORT_REQUEST));
}

needsAborting()

bool ossimProcessInterface::needsAborting

(

)

const

Definition at line 40 of file ossimProcessInterface.cpp.

References isAborted(), and isAbortRequested().

Referenced by ossimImageHistogramSource::computeFastModeHistogram(), ossimImageHistogramSource::computeNormalModeHistogram(), ossimViewshedTool::computeViewshed(), ossimImageHistogramSource::execute(), ossimNitf20Writer::writeBlockBandSeparate(), ossimNitfWriter::writeBlockBandSeparate(), ossimNitf20Writer::writeBlockBandSequential(), ossimNitfWriter::writeBlockBandSequential(), ossimImageFileWriter::writeHistogramFile(), and ossimImageFileWriter::writeMetaDataFiles().

{
   return ( isAborted()|| isAbortRequested() );
}

print()

std::ostream & ossimProcessInterface::print ( std::ostream &  out ) const

virtual

Called by friend operator<< function, derived classes should override if something different is desired.

Reimplemented in ossimGdalOverviewBuilder, and ossimKakaduNitfOverviewBuilder.

Definition at line 121 of file ossimProcessInterface.cpp.

References PROCESS_STATUS_ABORTED, PROCESS_STATUS_EXECUTING, PROCESS_STATUS_NOT_EXECUTING, thePercentComplete, and theProcessStatus.

Referenced by operator<<().

{
   out << "process status: ";
   if(theProcessStatus == PROCESS_STATUS_EXECUTING)
   {
      out << "executing" << std::endl;
   }
   else if(theProcessStatus == PROCESS_STATUS_ABORTED)
   {
      out << "aborted" << std::endl;
   }
   else if(theProcessStatus == PROCESS_STATUS_NOT_EXECUTING)
   {
      out << "not executing" << std::endl;
   }
   out << "percent_complete: " << thePercentComplete;
   
   return out;
}

setCurrentMessage()

void ossimProcessInterface::setCurrentMessage

(

const ossimString &

message

)

Definition at line 106 of file ossimProcessInterface.cpp.

References ossimListenerManager::fireEvent(), getManager(), getObject(), theEventFlag, theMessage, and thePercentComplete.

Referenced by ossimHistogramWriter::processProgressEvent().

{
   theMessage = message;

   ossimListenerManager* manager = getManager();
   if(theEventFlag&&manager)
   {
      ossimProcessProgressEvent event(getObject(),
                                      thePercentComplete,
                                      theMessage,
                                      true);
      manager->fireEvent(event);
   }   
}

setPercentComplete()

void ossimProcessInterface::setPercentComplete ( double  percentComplete )

virtual

Reimplemented in ossimImageFileWriter, ossimVertexExtractor, and ossimMetadataFileWriter.

Definition at line 76 of file ossimProcessInterface.cpp.

References ossimListenerManager::fireEvent(), getManager(), getObject(), theEventFlag, theMessage, and thePercentComplete.

Referenced by ossimImageHistogramSource::computeFastModeHistogram(), ossimHlzTool::computeHLZ(), ossimImageHistogramSource::computeNormalModeHistogram(), ossimHistogramWriter::processProgressEvent(), ossimMetadataFileWriter::setPercentComplete(), ossimVertexExtractor::setPercentComplete(), and ossimImageFileWriter::setPercentComplete().

{
   thePercentComplete = percentComplete;

   ossimListenerManager* manager = getManager();
   if(theEventFlag&&manager)
   {
      ossimProcessProgressEvent event(getObject(),
                                      thePercentComplete,
                                      theMessage,
                                      false);
      manager->fireEvent(event);
   }
}

setProcessStatus()

void ossimProcessInterface::setProcessStatus ( ossimProcessStatus  processStatus )

virtual

Definition at line 66 of file ossimProcessInterface.cpp.

References theProcessStatus.

Referenced by abort(), ossimHistogramWriter::abort(), and ossimImageHistogramSource::execute().

{
   theProcessStatus = processStatus;
}

Friends And Related Function Documentation

operator<<

OSSIM_DLL std::ostream& operator<< ( std::ostream &  out, const ossimProcessInterface &  data  )

friend

Definition at line 141 of file ossimProcessInterface.cpp.

{
   return data.print(out);
}

Member Data Documentation

theEventFlag

bool ossimProcessInterface::theEventFlag

protected

Definition at line 81 of file ossimProcessInterface.h.

Referenced by disableEvents(), enableEvents(), setCurrentMessage(), and setPercentComplete().

theMessage

ossimString ossimProcessInterface::theMessage

protected

Definition at line 80 of file ossimProcessInterface.h.

Referenced by setCurrentMessage(), and setPercentComplete().

thePercentComplete

double ossimProcessInterface::thePercentComplete

protected

Definition at line 78 of file ossimProcessInterface.h.

Referenced by getPercentComplete(), print(), setCurrentMessage(), and setPercentComplete().

theProcessStatus

ossimProcessStatus ossimProcessInterface::theProcessStatus

protected

Definition at line 79 of file ossimProcessInterface.h.

Referenced by abort(), getProcessStatus(), isAborted(), isAbortRequested(), isExecuting(), print(), and setProcessStatus().

---

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

• ossimProcessInterface.h
• ossimProcessInterface.cpp