// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
/**
 * @class   vtkPVTimerInformation
 * @brief   Holds timer log for all processes.
 *
 * I am using this information object to gather timer logs from all processes.
 */

#ifndef vtkPVTimerInformation_h
#define vtkPVTimerInformation_h

#include "vtkPVInformation.h"
#include "vtkRemotingCoreModule.h" //needed for exports

class VTKREMOTINGCORE_EXPORT vtkPVTimerInformation : public vtkPVInformation
{
public:
  static vtkPVTimerInformation* New();
  vtkTypeMacro(vtkPVTimerInformation, vtkPVInformation);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  ///@{
  /**
   * Get/Set the threshold to use to gather the timer log information. This must
   * be set before calling GatherInformation().
   */
  vtkSetMacro(LogThreshold, double);
  vtkGetMacro(LogThreshold, double);
  ///@}

  ///@{
  /**
   * Access to the logs.
   */
  int GetNumberOfLogs();
  char* GetLog(int proc);
  ///@}

  ///@{
  /**
   * Transfer information about a single object into
   * this object.
   */
  void CopyFromObject(vtkObject* data) override;
  virtual void CopyFromMessage(unsigned char* msg);
  ///@}

  /**
   * Merge another information object.
   */
  void AddInformation(vtkPVInformation* info) override;

  ///@{
  /**
   * Serialize objects to/from a stream object.
   */
  void CopyToStream(vtkClientServerStream*) override;
  void CopyFromStream(const vtkClientServerStream* css) override;
  ///@}

  ///@{
  /**
   * Serialize/Deserialize the parameters that control how/what information is
   * gathered. This are different from the ivars that constitute the gathered
   * information itself.
   */
  void CopyParametersToStream(vtkMultiProcessStream&) override;
  void CopyParametersFromStream(vtkMultiProcessStream&) override;

protected:
  vtkPVTimerInformation();
  ~vtkPVTimerInformation() override;
  ///@}

  void Reallocate(int num);
  void InsertLog(int id, const char* log);

  double LogThreshold;
  int NumberOfLogs;
  char** Logs;

  vtkPVTimerInformation(const vtkPVTimerInformation&) = delete;
  void operator=(const vtkPVTimerInformation&) = delete;
};

#endif
