VTK  9.1.0
vtkMPIEventLog.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkMPIEventLog.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
33#ifndef vtkMPIEventLog_h
34#define vtkMPIEventLog_h
35
36#include "vtkObject.h"
37#include "vtkParallelMPIModule.h" // For export macro
38
39class VTKPARALLELMPI_EXPORT vtkMPIEventLog : public vtkObject
40{
41public:
42 vtkTypeMacro(vtkMPIEventLog, vtkObject);
43
49
60 int SetDescription(const char* name, const char* desc);
61
63
69 static void InitializeLogging();
70 static void FinalizeLogging(VTK_FILEPATH const char* fileName);
72
74
80
81 void PrintSelf(ostream& os, vtkIndent indent) override;
82
83protected:
85 ~vtkMPIEventLog() override;
86
87 static int LastEventId;
88 int Active;
90 int EndId;
91
92private:
93 vtkMPIEventLog(const vtkMPIEventLog&) = delete;
94 void operator=(const vtkMPIEventLog&) = delete;
95};
96
97#endif
a simple class to control print indentation
Definition: vtkIndent.h:113
Class for logging and timing.
~vtkMPIEventLog() override
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static void InitializeLogging()
These methods have to be called once on all processors before and after invoking any logging events.
static vtkMPIEventLog * New()
Construct a vtkMPIEventLog with the following initial state: Processes = 0, MaximumNumberOfProcesses ...
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.
void StartLogging()
Issue start and stop events for this log entry.
void StopLogging()
Issue start and stop events for this log entry.
int SetDescription(const char *name, const char *desc)
Used to initialize the underlying mpe event.
static int LastEventId
abstract base class for most VTK objects
Definition: vtkObject.h:82
#define VTK_FILEPATH