VTK
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
vtkMPIEventLog Class Reference

Class for logging and timing. More...

#include <vtkMPIEventLog.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkMPIEventLogNewInstance () const
 
int SetDescription (const char *name, const char *desc)
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
void StartLogging ()
 
void StopLogging ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMPIEventLogSafeDownCast (vtkObjectBase *o)
 
static vtkMPIEventLogNew ()
 
static void InitializeLogging ()
 
static void FinalizeLogging (const char *fileName)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkMPIEventLog ()
 
 ~vtkMPIEventLog ()
 

Protected Attributes

int Active
 
int BeginId
 
int EndId
 

Static Protected Attributes

static int LastEventId
 

Detailed Description

Class for logging and timing.

This class is wrapper around MPE event logging functions (available from Argonne National Lab/Missippi State University). It allows users to create events with names and log them. Different log file formats can be generated by changing MPE's configuration. Some of these formats are binary (for examples SLOG and CLOG) and can be analyzed with viewers from ANL. ALOG is particularly useful since it is text based and can be processed with simple scripts.

See Also
vtkTimerLog vtkMPIController vtkMPICommunicator

Definition at line 38 of file vtkMPIEventLog.h.

Member Typedef Documentation

typedef vtkObject vtkMPIEventLog::Superclass

Definition at line 41 of file vtkMPIEventLog.h.

Constructor & Destructor Documentation

vtkMPIEventLog::vtkMPIEventLog ( )
protected
vtkMPIEventLog::~vtkMPIEventLog ( )
protected

Member Function Documentation

static int vtkMPIEventLog::IsTypeOf ( const char *  type)
static
virtual int vtkMPIEventLog::IsA ( const char *  type)
virtual
static vtkMPIEventLog* vtkMPIEventLog::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkMPIEventLog::NewInstanceInternal ( ) const
protectedvirtual
vtkMPIEventLog* vtkMPIEventLog::NewInstance ( ) const
static vtkMPIEventLog* vtkMPIEventLog::New ( )
static

Construct a vtkMPIEventLog with the following initial state: Processes = 0, MaximumNumberOfProcesses = 0.

int vtkMPIEventLog::SetDescription ( const char *  name,
const char *  desc 
)

Used to initialize the underlying mpe event. HAS TO BE CALLED BY ALL PROCESSES before any event logging is done. It takes a name and a description for the graphical representation, for example, "red:vlines3". See mpe documentation for details. Returns 0 on MPI failure (or aborts depending on MPI error handlers)

static void vtkMPIEventLog::InitializeLogging ( )
static

These methods have to be called once on all processors before and after invoking any logging events. The name of the logfile is given by fileName. See mpe documentation for file formats.

static void vtkMPIEventLog::FinalizeLogging ( const char *  fileName)
static

These methods have to be called once on all processors before and after invoking any logging events. The name of the logfile is given by fileName. See mpe documentation for file formats.

void vtkMPIEventLog::StartLogging ( )

Issue start and stop events for this log entry.

void vtkMPIEventLog::StopLogging ( )

Issue start and stop events for this log entry.

virtual void vtkMPIEventLog::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Member Data Documentation

int vtkMPIEventLog::LastEventId
staticprotected

Definition at line 75 of file vtkMPIEventLog.h.

int vtkMPIEventLog::Active
protected

Definition at line 76 of file vtkMPIEventLog.h.

int vtkMPIEventLog::BeginId
protected

Definition at line 77 of file vtkMPIEventLog.h.

int vtkMPIEventLog::EndId
protected

Definition at line 78 of file vtkMPIEventLog.h.


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