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

Inheritance diagram for vtkMPIEventLog:
[legend]
Collaboration diagram for vtkMPIEventLog:
[legend]

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. More...
 
vtkMPIEventLogNewInstance () const
 
int SetDescription (const char *name, const char *desc)
 Used to initialize the underlying mpe event. More...
 
void StartLogging ()
 Issue start and stop events for this log entry. More...
 
void StopLogging ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMPIEventLogSafeDownCast (vtkObjectBase *o)
 
static vtkMPIEventLogNew ()
 Construct a vtkMPIEventLog with the following initial state: Processes = 0, MaximumNumberOfProcesses = 0. More...
 
static void InitializeLogging ()
 These methods have to be called once on all processors before and after invoking any logging events. More...
 
static void FinalizeLogging (const char *fileName)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkMPIEventLog ()
 
 ~vtkMPIEventLog ()
 
- 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. More...
 
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
std::atomic< int32_t > 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 39 of file vtkMPIEventLog.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkMPIEventLog.h.

Constructor & Destructor Documentation

◆ vtkMPIEventLog()

vtkMPIEventLog::vtkMPIEventLog ( )
protected

◆ ~vtkMPIEventLog()

vtkMPIEventLog::~vtkMPIEventLog ( )
protected

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 ( const char *  fileName)
static

◆ StartLogging()

void vtkMPIEventLog::StartLogging ( )

Issue start and stop events for this log entry.

◆ StopLogging()

void vtkMPIEventLog::StopLogging ( )

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

◆ Active

int vtkMPIEventLog::Active
protected

Definition at line 89 of file vtkMPIEventLog.h.

◆ BeginId

int vtkMPIEventLog::BeginId
protected

Definition at line 90 of file vtkMPIEventLog.h.

◆ EndId

int vtkMPIEventLog::EndId
protected

Definition at line 91 of file vtkMPIEventLog.h.


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