#include <ossimProcessProgressEvent.h>

Inheritance diagram for ossimProcessProgressEvent:

Public Member Functions
	ossimProcessProgressEvent (ossimObject *owner=NULL, double percentComplete=0.0, const ossimString message="", bool outputMessageFlag=false)

virtual ossimObject *	dup () const

double	getPercentComplete () const

ossimString	getMessage () const

void	getMessage (ossimString &message) const

void	setPercentComplete (double percentComplete)

void	setMessage (const ossimString &message)

void	setOutputMessageFlag (bool flag)

bool	getOutputMessageFlag () const

Public Member Functions inherited from ossimEvent
	ossimEvent (ossimObject *object=NULL, long id=OSSIM_EVENT_NULL_ID)

	ossimEvent (const ossimEvent &rhs)

long	getId () const

void	setId (long id)

bool	isConsumed () const

void	setConsumedFlag (bool flag=true)

void	consume ()

const ossimObject *	getObject () const
	This is the originating object that originally produced the event. More...

ossimObject *	getObject ()

const ossimObject *	getCurrentObject () const

ossimObject *	getCurrentObject ()

void	setObject (ossimObject *object)

void	setCurrentObject (ossimObject *object)

void	setPropagationType (PropagationType type)

bool	isPropagatingToOutputs () const

bool	isPropagatingToInputs () const

Public Member Functions inherited from ossimObject
	ossimObject ()

virtual	~ossimObject ()

virtual ossimString	getShortName () const

virtual ossimString	getLongName () const

virtual ossimString	getDescription () const

virtual ossimString	getClassName () const

virtual RTTItypeid	getType () const

virtual bool	canCastTo (ossimObject *obj) const

virtual bool	canCastTo (const RTTItypeid &id) const

virtual bool	canCastTo (const ossimString &parentClassName) const

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)

virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...

virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const

virtual void	accept (ossimVisitor &visitor)

Public Member Functions inherited from ossimReferenced
	ossimReferenced ()

	ossimReferenced (const ossimReferenced &)

ossimReferenced &	operator= (const ossimReferenced &)

void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

int	referenceCount () const

Protected Attributes
double	thePercentComplete

ossimString	theMessage

bool	theOutputMessageFlag

Protected Attributes inherited from ossimEvent
ossimObject *	theObject

ossimObject *	theCurrentObject

long	theId

bool	theIsConsumedFlag

PropagationType	thePropagationType

Additional Inherited Members
Public Types inherited from ossimEvent
enum	PropagationType { PROPAGATION_NONE = 0, PROPAGATION_INPUT = 1, PROPAGATION_OUTPUT = 2 }

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Detailed Description

Definition at line 20 of file ossimProcessProgressEvent.h.

Constructor & Destructor Documentation

◆ ossimProcessProgressEvent()

ossimProcessProgressEvent::ossimProcessProgressEvent	(	ossimObject *	owner = `NULL`,
		double	percentComplete = `0.0`,
		const ossimString	message = `""`,
		bool	outputMessageFlag = `false`
	)

Definition at line 18 of file ossimProcessProgressEvent.cpp.

Referenced by dup().

    :
       ossimEvent(owner, OSSIM_EVENT_PROCESS_PROGRESS_ID),
       thePercentComplete(percentComplete),
       theMessage(message),
       theOutputMessageFlag(outputMessageFlag)
 {
 }

Member Function Documentation

◆ dup()

ossimObject * ossimProcessProgressEvent::dup ( ) const

virtual

Reimplemented from ossimObject.

Definition at line 30 of file ossimProcessProgressEvent.cpp.

References ossimProcessProgressEvent().

 {
    return new ossimProcessProgressEvent(*this);
 }

◆ getMessage() [1/2]

ossimString ossimProcessProgressEvent::getMessage ( ) const

Definition at line 40 of file ossimProcessProgressEvent.cpp.

References theMessage.

Referenced by ossimHistogramWriter::processProgressEvent().

 {
    return theMessage;
 }

◆ getMessage() [2/2]

void ossimProcessProgressEvent::getMessage ( ossimString & message ) const

Definition at line 45 of file ossimProcessProgressEvent.cpp.

References theMessage.

 {
    message = theMessage;
 }

◆ getOutputMessageFlag()

bool ossimProcessProgressEvent::getOutputMessageFlag ( ) const

Definition at line 65 of file ossimProcessProgressEvent.cpp.

References theOutputMessageFlag.

Referenced by ossimStdOutProgress::processProgressEvent().

 {
    return theOutputMessageFlag;
 }

◆ getPercentComplete()

double ossimProcessProgressEvent::getPercentComplete ( ) const

Definition at line 35 of file ossimProcessProgressEvent.cpp.

References thePercentComplete.

Referenced by ossimHistogramWriter::processProgressEvent().

 {
    return thePercentComplete;
 }

◆ setMessage()

void ossimProcessProgressEvent::setMessage ( const ossimString & message )

Definition at line 55 of file ossimProcessProgressEvent.cpp.

References theMessage.

 {
    theMessage = message;
 }

◆ setOutputMessageFlag()

void ossimProcessProgressEvent::setOutputMessageFlag ( bool flag )

Definition at line 60 of file ossimProcessProgressEvent.cpp.

References theOutputMessageFlag.

 {
    theOutputMessageFlag = flag;
 }

◆ setPercentComplete()

void ossimProcessProgressEvent::setPercentComplete ( double percentComplete )

Definition at line 50 of file ossimProcessProgressEvent.cpp.

References thePercentComplete.

 {
    thePercentComplete = percentComplete;
 }

Member Data Documentation

◆ theMessage

ossimString ossimProcessProgressEvent::theMessage

protected

Definition at line 46 of file ossimProcessProgressEvent.h.

Referenced by getMessage(), and setMessage().

◆ theOutputMessageFlag

bool ossimProcessProgressEvent::theOutputMessageFlag

protected

Definition at line 47 of file ossimProcessProgressEvent.h.

Referenced by getOutputMessageFlag(), and setOutputMessageFlag().

◆ thePercentComplete

double ossimProcessProgressEvent::thePercentComplete

protected

Definition at line 45 of file ossimProcessProgressEvent.h.

Referenced by getPercentComplete(), and setPercentComplete().

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimProcessProgressEvent()

Member Function Documentation

◆ dup()

◆ getMessage() [1/2]

◆ getMessage() [2/2]

◆ getOutputMessageFlag()

◆ getPercentComplete()

◆ setMessage()

◆ setOutputMessageFlag()

◆ setPercentComplete()

Member Data Documentation

◆ theMessage

◆ theOutputMessageFlag

◆ thePercentComplete