vtkSMExtractsController.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMExtractsController_h
#define vtkSMExtractsController_h

#include "vtkObject.h"
#include "vtkRemotingServerManagerModule.h" // for exports
#include "vtkSmartPointer.h"                // for vtkSmartPointer

#include <map>    // for std::map
#include <string> // for std::string
#include <vector> // for std::vector

class vtkCollection;
class vtkSMExtractWriterProxy;
class vtkSMProxy;
class vtkSMSessionProxyManager;
class vtkTable;

class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMExtractsController : public vtkObject
{
public:
  static vtkSMExtractsController* New();
  vtkTypeMacro(vtkSMExtractsController, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetClampMacro(TimeStep, int, 0, VTK_INT_MAX);
  vtkGetMacro(TimeStep, int);
  vtkSetMacro(Time, double);
  vtkGetMacro(Time, double);


  vtkSetStringMacro(ExtractsOutputDirectory);
  vtkGetStringMacro(ExtractsOutputDirectory);

  const char* GetRealExtractsOutputDirectory() const;

  bool Extract(vtkSMProxy* extractor);

  bool Extract(vtkSMSessionProxyManager* pxm);

  bool Extract();

  bool Extract(vtkCollection* collection);


  bool IsAnyTriggerActivated(vtkSMSessionProxyManager* pxm);
  bool IsAnyTriggerActivated();
  bool IsAnyTriggerActivated(vtkCollection* collection);

  bool IsTriggerActivated(vtkSMProxy* extractor);

  std::vector<vtkSMProxy*> FindExtractors(vtkSMProxy* proxy) const;

  std::vector<vtkSMProxy*> GetSupportedExtractorPrototypes(vtkSMProxy* proxy) const;

  bool CanExtract(vtkSMProxy* extractor, const std::vector<vtkSMProxy*>& inputs) const;
  bool CanExtract(vtkSMProxy* extractor, vtkSMProxy* input) const
  {
    return this->CanExtract(extractor, std::vector<vtkSMProxy*>{ input });
  }


  vtkSMProxy* CreateExtractor(
    vtkSMProxy* proxy, const char* xmlname, const char* registrationName = nullptr) const;

  vtkSMProxy* CreateSteeringExtractor(
    vtkSMProxy* proxy, const char* registrationName = nullptr) const;

  static bool IsExtractor(vtkSMProxy* extractor, vtkSMProxy* proxy);

  vtkSMProxy* GetInputForExtractor(vtkSMProxy* extractor) const;

  vtkTable* GetSummaryTable() const;

  void ResetSummaryTable();

  bool SaveSummaryTable(const std::string& fname, vtkSMSessionProxyManager* pxm);


  using SummaryParametersT = std::map<std::string, std::string>;
  bool AddSummaryEntry(vtkSMExtractWriterProxy* writer, const std::string& filename,
    const SummaryParametersT& params = SummaryParametersT{});

  static bool IsExtractorEnabled(vtkSMProxy* extractor);

  static void SetExtractorEnabled(vtkSMProxy* extractor, bool val);

protected:
  vtkSMExtractsController();
  ~vtkSMExtractsController() override;


  bool CreateExtractsOutputDirectory(vtkSMSessionProxyManager* pxm) const;
  bool CreateDir(const std::string& dname, vtkSMSessionProxyManager* pxm) const;

  std::string GetName(vtkSMExtractWriterProxy* writer);

private:
  vtkSMExtractsController(const vtkSMExtractsController&) = delete;
  void operator=(const vtkSMExtractsController&) = delete;

  static std::string GetSummaryTableFilenameColumnName(const std::string& fname);

  int TimeStep;
  double Time;
  char* ExtractsOutputDirectory;
  char* EnvironmentExtractsOutputDirectory;
  vtkSmartPointer<vtkTable> SummaryTable;
  mutable std::string LastExtractsOutputDirectory;
  mutable bool ExtractsOutputDirectoryValid;

  vtkSetStringMacro(EnvironmentExtractsOutputDirectory);
};

#endif