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 Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkMPIEventLog *	NewInstance () const
int	SetDescription (const char *name, const char *desc)
	Used to initialize the underlying mpe event.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	StartLogging ()
	Issue start and stop events for this log entry.
void	StopLogging ()
	Issue start and stop events for this log entry.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkMPIEventLog *	SafeDownCast (vtkObjectBase *o)
static vtkMPIEventLog *	New ()
	Construct a vtkMPIEventLog with the following initial state: Processes = 0, MaximumNumberOfProcesses = 0.
static void	InitializeLogging ()
	These methods have to be called once on all processors before and after invoking any logging events.
static void	FinalizeLogging (VTK_FILEPATH const char *fileName)
	These methods have to be called once on all processors before and after invoking any logging events.
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkMPIEventLog ()
	~vtkMPIEventLog () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
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
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Static Protected Attributes
static int	LastEventId

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

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 39 of file vtkMPIEventLog.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkMPIEventLog::Superclass

Definition at line 42 of file vtkMPIEventLog.h.

Constructor & Destructor Documentation

vtkMPIEventLog()

vtkMPIEventLog::vtkMPIEventLog ( )

protected

~vtkMPIEventLog()

vtkMPIEventLog::~vtkMPIEventLog ( )

overrideprotected

Member Function Documentation

IsTypeOf()

static vtkTypeBool vtkMPIEventLog::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool 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 vtkObjectBase.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkMPIEventLog::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkMPIEventLog * vtkMPIEventLog::NewInstance

(

)

const

New()

static vtkMPIEventLog * vtkMPIEventLog::New ( )

static

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

SetDescription()

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)

InitializeLogging()

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.

FinalizeLogging()

static void vtkMPIEventLog::FinalizeLogging ( VTK_FILEPATH 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.

StartLogging()

void vtkMPIEventLog::StartLogging

(

)

Issue start and stop events for this log entry.

StopLogging()

void vtkMPIEventLog::StopLogging

(

)

Issue start and stop events for this log entry.

PrintSelf()

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

overridevirtual

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

LastEventId

int vtkMPIEventLog::LastEventId

staticprotected

Definition at line 87 of file vtkMPIEventLog.h.

Active

int vtkMPIEventLog::Active

protected

Definition at line 88 of file vtkMPIEventLog.h.

BeginId

int vtkMPIEventLog::BeginId

protected

Definition at line 89 of file vtkMPIEventLog.h.

EndId

int vtkMPIEventLog::EndId

protected

Definition at line 90 of file vtkMPIEventLog.h.

---

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

• Parallel/MPI/vtkMPIEventLog.h