vtkMPIEventLog Class Reference

Class for logging and timing. More...

#include <vtkMPIEventLog.h>

Inheritance diagram for vtkMPIEventLog:

Collaboration diagram for vtkMPIEventLog:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	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 ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

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)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkMPIEventLog ()
	~vtkMPIEventLog ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
int	Active
int	BeginId
int	EndId
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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 *  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

virtual vtkObjectBase* vtkMPIEventLog::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

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

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.

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:

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Parallel/MPI/vtkMPIEventLog.h