OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
otb::MPIConfig Class Reference

#include <otbMPIConfig.h>

+ Inheritance diagram for otb::MPIConfig:
+ Collaboration diagram for otb::MPIConfig:

Public Types

typedef itk::SmartPointer
< const Self
typedef itk::SmartPointer< SelfPointer
typedef MPIConfig Self
typedef itk::Object Superclass
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef LightObject Self

Public Member Functions

void abort (int errCode)
void barrier ()
virtual const char * GetNameOfClass () const
void Init (int &argc, char **&argv, bool abortOnException=true)
void logError (const std::string message)
void logInfo (const std::string message)
void terminate ()
virtual unsigned int GetMyRank ()
virtual unsigned int GetNbProcs ()
- Public Member Functions inherited from itk::LightObject
virtual Pointer CreateAnother () const
virtual void Delete ()
virtual int GetReferenceCount () const
 itkCloneMacro (Self)
void Print (std::ostream &os, Indent indent=0) const
virtual void Register () const
virtual void SetReferenceCount (int)
virtual void UnRegister () const noexcept

Static Public Member Functions

static Pointer Instance ()
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
static Pointer New ()

Protected Member Functions

 MPIConfig ()
virtual ~MPIConfig ()
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintSelf (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()

Private Member Functions

 MPIConfig (const MPIConfig &)=delete
void operator= (const MPIConfig &)=delete

Private Attributes

bool m_abortOnException
bool m_initialized
unsigned int m_MyRank
unsigned int m_NbProcs
bool m_terminated

Static Private Attributes

static Pointer m_Singleton

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount

Detailed Description

Definition at line 38 of file otbMPIConfig.h.

Member Typedef Documentation

Definition at line 45 of file otbMPIConfig.h.

Definition at line 44 of file otbMPIConfig.h.

Standard class typedefs.

Definition at line 42 of file otbMPIConfig.h.

Definition at line 43 of file otbMPIConfig.h.

Constructor & Destructor Documentation

otb::MPIConfig::MPIConfig ( )


virtual otb::MPIConfig::~MPIConfig ( )


otb::MPIConfig::MPIConfig ( const MPIConfig )

Member Function Documentation

void otb::MPIConfig::abort ( int  errCode)

Abort all MPI processus.

void otb::MPIConfig::barrier ( )

Blocks until all processes have reached this routine

virtual unsigned int otb::MPIConfig::GetMyRank ( )

MPI Parameters accessors

virtual const char* otb::MPIConfig::GetNameOfClass ( ) const

Run-time type information (and related methods).

Reimplemented from itk::LightObject.

virtual unsigned int otb::MPIConfig::GetNbProcs ( )

MPI Parameters accessors

void otb::MPIConfig::Init ( int &  argc,
char **&  argv,
bool  abortOnException = true 

Initialize MPI Processus

static Pointer otb::MPIConfig::Instance ( )
void otb::MPIConfig::logError ( const std::string  message)

Log error

void otb::MPIConfig::logInfo ( const std::string  message)

Log info

void otb::MPIConfig::operator= ( const MPIConfig )
void otb::MPIConfig::terminate ( )

Shuts down the MPI environment.

Member Data Documentation

bool otb::MPIConfig::m_abortOnException

Definition at line 93 of file otbMPIConfig.h.

bool otb::MPIConfig::m_initialized

Definition at line 95 of file otbMPIConfig.h.

unsigned int otb::MPIConfig::m_MyRank

Definition at line 89 of file otbMPIConfig.h.

unsigned int otb::MPIConfig::m_NbProcs

Definition at line 91 of file otbMPIConfig.h.

Pointer otb::MPIConfig::m_Singleton

Definition at line 99 of file otbMPIConfig.h.

bool otb::MPIConfig::m_terminated

Definition at line 97 of file otbMPIConfig.h.

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