ossimStdOutProgress Class Reference

#include <ossimStdOutProgress.h>

Inheritance diagram for ossimStdOutProgress:

Public Member Functions
	ossimStdOutProgress (ossim_uint32 precision=0, bool flushStream=false)
virtual void	processProgressEvent (ossimProcessProgressEvent &event)
virtual void	setFlushStreamFlag (bool flag)
Public Member Functions inherited from ossimProcessListener
	ossimProcessListener ()
virtual	~ossimProcessListener ()
virtual void	processEvent (ossimEvent &event)
	ProcessEvent. More...
Public Member Functions inherited from ossimListener
	ossimListener ()
virtual	~ossimListener ()
void	enableListener ()
void	disableListener ()
void	setListenerEnableFlag (bool flag)
bool	isListenerEnabled () const
bool	getListenerEnableFlag () const

Protected Attributes
ossim_uint32	thePrecision
bool	theFlushStreamFlag
bool	theRunningInConsoleFlag
Protected Attributes inherited from ossimListener
bool	theListenerEnableFlag

Detailed Description

Definition at line 19 of file ossimStdOutProgress.h.

Constructor & Destructor Documentation

ossimStdOutProgress()

ossimStdOutProgress::ossimStdOutProgress	(	ossim_uint32	precision = 0,
		bool	flushStream = false
	)

Definition at line 29 of file ossimStdOutProgress.cpp.

References FILENO, ossimPreferences::findPreference(), ossimPreferences::instance(), ISATTY, ossimString::size(), theRunningInConsoleFlag, and ossimString::toBool().

   :
      ossimProcessListener(),
      thePrecision(precision),
      theFlushStreamFlag(flushStream),
      theRunningInConsoleFlag(true)
{
   // Determine if running in a terminal window. Progress reports are only written to console if
   // running in one.

   ossimString stdOutConsole;
   stdOutConsole = ossimPreferences::instance()->findPreference("ossim.std.out.progress");

   if ( stdOutConsole.size() )
   {
      // Override auto detected console.
      theRunningInConsoleFlag = stdOutConsole.toBool();
   }
   else if ( !ISATTY(FILENO(stdout) ) )
   {
      theRunningInConsoleFlag = false;
   }
}

Member Function Documentation

processProgressEvent()

void ossimStdOutProgress::processProgressEvent ( ossimProcessProgressEvent &  event )

virtual

Reimplemented from ossimProcessListener.

Definition at line 54 of file ossimStdOutProgress.cpp.

References ossimString::c_str(), ossimString::empty(), ossimProcessProgressEvent::getOutputMessageFlag(), ossimNotify(), ossimNotifyLevel_NOTICE, theFlushStreamFlag, thePrecision, and theRunningInConsoleFlag.

{
   if (!theRunningInConsoleFlag)
      return;

   if (event.getOutputMessageFlag())
   {
      ossimString s;
      event.getMessage(s);
      if (!s.empty())
      {
         ossimNotify(ossimNotifyLevel_NOTICE) << s.c_str() << std::endl;
      }
      return; // Don't output percentage on a message update.
   }
   
   double p = event.getPercentComplete();
   ossimNotify(ossimNotifyLevel_NOTICE)
      << std::setiosflags(std::ios::fixed)
      << std::setprecision(thePrecision)
      << p << "%\r";
   
   if(theFlushStreamFlag)
   {
      (p != 100.0) ?
         ossimNotify(ossimNotifyLevel_NOTICE).flush() :
         ossimNotify(ossimNotifyLevel_NOTICE) << "\n";
   }
}

setFlushStreamFlag()

void ossimStdOutProgress::setFlushStreamFlag ( bool  flag )

virtual

Definition at line 84 of file ossimStdOutProgress.cpp.

References theFlushStreamFlag.

{
   theFlushStreamFlag = flag;
}

Member Data Documentation

theFlushStreamFlag

bool ossimStdOutProgress::theFlushStreamFlag

protected

Definition at line 30 of file ossimStdOutProgress.h.

Referenced by processProgressEvent(), and setFlushStreamFlag().

thePrecision

ossim_uint32 ossimStdOutProgress::thePrecision

protected

Definition at line 29 of file ossimStdOutProgress.h.

Referenced by processProgressEvent().

theRunningInConsoleFlag

bool ossimStdOutProgress::theRunningInConsoleFlag

protected

Definition at line 31 of file ossimStdOutProgress.h.

Referenced by ossimStdOutProgress(), and processProgressEvent().

---

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

• ossimStdOutProgress.h
• ossimStdOutProgress.cpp