vtkParallelTimer.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
//
#ifndef vtkParallelTimer_h
#define vtkParallelTimer_h
 
#define vtkParallelTimerDEBUG -1
 
#include "vtkObject.h"
#include "vtkRenderingParallelLICModule.h" // for export
 
#include <sstream> // for sstream
#include <string>  // for string
#include <vector>  // for vector
#if vtkParallelTimerDEBUG > 0
#include <iostream> // for cerr
#endif
 
VTK_ABI_NAMESPACE_BEGIN
class vtkParallelTimerBuffer;
 
class VTKRENDERINGPARALLELLIC_EXPORT vtkParallelTimer : public vtkObject
{
public:
  static vtkParallelTimer* New();
  vtkTypeMacro(vtkParallelTimer, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
 
  class LogHeaderType
  {
  public:
    template <typename T>
    LogHeaderType& operator<<(const T& s);
  };
 
 
  class LogBodyType
  {
  public:
    template <typename T>
    LogBodyType& operator<<(const T& s);
  };
 
 
  vtkSetMacro(WriterRank, int);
  vtkGetMacro(WriterRank, int);
 
 
  vtkSetFilePathMacro(FileName);
  vtkGetFilePathMacro(FileName);
 
  void SetFileName(VTK_FILEPATH const std::string& fileName)
  {
    this->SetFileName(fileName.c_str());
  }
 
 
  void StartEvent(const char* event);
  void StartEvent(int rank, const char* event);
  void EndEvent(const char* event);
  void EndEvent(int rank, const char* event);
  void EndEventSynch(const char* event);
  void EndEventSynch(int rank, const char* event);
 
  template <typename T>
  vtkParallelTimer& operator<<(const T& s);
 
  vtkParallelTimer::LogHeaderType GetHeader() { return vtkParallelTimer::LogHeaderType(); }
 
  vtkParallelTimer::LogBodyType GetBody() { return vtkParallelTimer::LogBodyType(); }
 
  void Clear();
 
  void Update();
 
  int Write();
 
  static vtkParallelTimer* GetGlobalInstance();
 
  static void DeleteGlobalInstance();
 
 
  vtkSetMacro(WriteOnClose, int);
  vtkGetMacro(WriteOnClose, int);
 
 
  vtkSetMacro(GlobalLevel, int);
  vtkGetMacro(GlobalLevel, int);
 
protected:
  vtkParallelTimer();
  ~vtkParallelTimer() override;
 
private:
  vtkParallelTimer(const vtkParallelTimer&) = delete;
  void operator=(const vtkParallelTimer&) = delete;
 
  class VTKRENDERINGPARALLELLIC_EXPORT vtkParallelTimerDestructor
  {
  public:
    vtkParallelTimerDestructor()
      : Log(nullptr)
    {
    }
    ~vtkParallelTimerDestructor();
 
    void SetLog(vtkParallelTimer* log) { this->Log = log; }
 
  private:
    vtkParallelTimer* Log;
  };
 
  int GlobalLevel;
  int Initialized;
  int WorldRank;
  int WriterRank;
  char* FileName;
  int WriteOnClose;
  std::vector<double> StartTime;
#if vtkParallelTimerDEBUG < 0
  std::vector<std::string> EventId;
#endif
 
  vtkParallelTimerBuffer* Log;
 
  static vtkParallelTimer* GlobalInstance;
  static vtkParallelTimerDestructor GlobalInstanceDestructor;
 
  std::ostringstream HeaderBuffer;
 
  friend class LogHeaderType;
  friend class LogBodyType;
};
 
//-----------------------------------------------------------------------------
template <typename T>
vtkParallelTimer& vtkParallelTimer::operator<<(const T& s)
{
  if (this->WorldRank == this->WriterRank)
  {
    this->HeaderBuffer << s;
#if vtkParallelTimerDEBUG > 0
    std::cerr << s;
#endif
  }
  return *this;
}
 
//-----------------------------------------------------------------------------
template <typename T>
vtkParallelTimer::LogHeaderType& vtkParallelTimer::LogHeaderType::operator<<(const T& s)
{
  vtkParallelTimer* log = vtkParallelTimer::GetGlobalInstance();
 
  if (log->WorldRank == log->WriterRank)
  {
    log->HeaderBuffer << s;
#if vtkParallelTimerDEBUG > 0
    std::cerr << s;
#endif
  }
 
  return *this;
}
 
//-----------------------------------------------------------------------------
template <typename T>
vtkParallelTimer::LogBodyType& vtkParallelTimer::LogBodyType::operator<<(const T& s)
{
  vtkParallelTimer* log = vtkParallelTimer::GetGlobalInstance();
 
  *(log->Log) << s;
#if vtkParallelTimerDEBUG > 0
  std::cerr << s;
#endif
 
  return *this;
}
 
VTK_ABI_NAMESPACE_END
#endif