Class for logging and timing. More...

#include <vtkMPIEventLog.h>

Inheritance diagram for vtkMPIEventLog:

Collaboration diagram for vtkMPIEventLog:

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkMPIEventLog *	NewInstance () 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 vtkMPIEventLog *	SafeDownCast (vtkObjectBase *o)
static vtkMPIEventLog *	New ()

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

Reimplemented from vtkObject.

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 * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int vtkMPIEventLog::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkMPIEventLog* vtkMPIEventLog::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkMPIEventLog::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

vtkMPIEventLog* vtkMPIEventLog::NewInstance ( ) const

Reimplemented from vtkObject.

static vtkMPIEventLog* vtkMPIEventLog::New ( ) [static]

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

Reimplemented from vtkObject.

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]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.