ossimMpi Class Reference

#include <ossimMpi.h>

Public Member Functions
ossim_float64	getTime () const
void	initialize (int *argc, char ***argv)
void	finalize ()
int	getRank () const
int	getNumberOfProcessors () const
void	setEnabledFlag (bool flag)
bool	isEnabled () const
void	barrier ()
	MPI Barrier method. More...

Static Public Member Functions
static ossimMpi *	instance ()

Protected Member Functions
	ossimMpi ()
	ossimMpi (const ossimMpi &)
void	operator= (const ossimMpi &)

Protected Attributes
bool	theEnabledFlag

Static Protected Attributes
static ossimMpi *	theInstance =0

Detailed Description

Definition at line 16 of file ossimMpi.h.

Constructor & Destructor Documentation

ossimMpi() [1/2]

ossimMpi::ossimMpi ( )

protected

Definition at line 168 of file ossimMpi.cpp.

Referenced by instance().

   : theEnabledFlag(false)
{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimMpi::ossimMpi entered..."
         << std::endl;
#ifdef OSSIM_ID_ENABLED
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "OSSIM_ID = " << OSSIM_ID << std::endl;
#endif
   }
}

ossimMpi() [2/2]

ossimMpi::ossimMpi ( const ossimMpi &  obj )

protected

Definition at line 183 of file ossimMpi.cpp.

   : theEnabledFlag(obj.theEnabledFlag)
{}

Member Function Documentation

barrier()

void ossimMpi::barrier

(

)

MPI Barrier method.

Blocks until all processes have reached this routine.

If MPI is enabled this will call: MPI_Barrier( MPI_COMM_WORLD ); else it will simply return.

Definition at line 42 of file ossimMpi.cpp.

References theEnabledFlag.

{
#if OSSIM_HAS_MPI
   if(theEnabledFlag)
   {
      // Blocks until all processes have reached this routine.
      MPI_Barrier( MPI_COMM_WORLD );
   }
#endif
}

finalize()

void ossimMpi::finalize

(

)

Called only once when we would like to shutdown mpi

Definition at line 115 of file ossimMpi.cpp.

References theEnabledFlag.

{
#if OSSIM_HAS_MPI
   if(theEnabledFlag)
   {
      int success;
      success = MPI_Finalize();
      if(traceDebug())
      {
         if(success == MPI_SUCCESS)
         {
            ossimNotify(ossimNotifyLevel_DEBUG)
               << "DEBUG ossimMpi::finalize(): mpi is finalized" << std::endl;
         }
         else
         {
            ossimNotify(ossimNotifyLevel_DEBUG)
               << "DEBUG ossimMpi::finalize(): "
               << "mpi is not finalized successfully" << std::endl;
         }
      }
   }
#endif
}

getNumberOfProcessors()

int ossimMpi::getNumberOfProcessors

(

)

const

Definition at line 154 of file ossimMpi.cpp.

References theEnabledFlag.

{
   int result = 1;

#if OSSIM_HAS_MPI
   if(theEnabledFlag)
   {
      MPI_Comm_size(MPI_COMM_WORLD, &result);
   }
#endif

   return result;
}

getRank()

int ossimMpi::getRank

(

)

const

Definition at line 140 of file ossimMpi.cpp.

References theEnabledFlag.

Referenced by ossimIgen::slaveSetup().

{
   int result = 0;

#if OSSIM_HAS_MPI
   if(theEnabledFlag)
   {
      MPI_Comm_rank(MPI_COMM_WORLD, &result);
   }
#endif
   
   return result;
}

getTime()

ossim_float64 ossimMpi::getTime

(

)

const

Definition at line 53 of file ossimMpi.cpp.

References theEnabledFlag.

{
#if OSSIM_HAS_MPI
   if(theEnabledFlag)
   {
      return MPI_Wtime();
   }
   else
   {
      return time(0);
   }
#else
   return time(0);
#endif
}

initialize()

void ossimMpi::initialize	(	int *	argc,
		char ***	argv
	)

Typically called only one time

Definition at line 99 of file ossimMpi.cpp.

{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "DEBUG ossimMpi::initialize: Not compiled with mpi!"
         << std::endl;
   }
}

instance()

ossimMpi * ossimMpi::instance ( )

static

Definition at line 27 of file ossimMpi.cpp.

References ossimMpi(), and theInstance.

Referenced by ossimIgen::initialize(), ossimIgen::initializeAttributes(), ossimIgen::outputProduct(), ossimIgen::slaveSetup(), and ossimIgen::writeToFile().

{
   if(!theInstance)
   {
      theInstance = new ossimMpi;
   }
   
   return theInstance;
}

isEnabled()

bool ossimMpi::isEnabled

(

)

const

Definition at line 37 of file ossimMpi.cpp.

References theEnabledFlag.

{
   return theEnabledFlag;
}

operator=()

void ossimMpi::operator= ( const ossimMpi &  rhs )

protected

Definition at line 187 of file ossimMpi.cpp.

References theEnabledFlag.

{
   theEnabledFlag = rhs.theEnabledFlag; 
}

setEnabledFlag()

void ossimMpi::setEnabledFlag

(

bool

flag

)

Definition at line 110 of file ossimMpi.cpp.

References theEnabledFlag.

{
   theEnabledFlag = flag;
}

Member Data Documentation

theEnabledFlag

bool ossimMpi::theEnabledFlag

protected

Definition at line 57 of file ossimMpi.h.

Referenced by barrier(), finalize(), getNumberOfProcessors(), getRank(), getTime(), isEnabled(), operator=(), and setEnabledFlag().

theInstance

ossimMpi * ossimMpi::theInstance =0

staticprotected

We will have only a single instance of this class.

Definition at line 56 of file ossimMpi.h.

Referenced by instance().

---

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

• ossimMpi.h
• ossimMpi.cpp