vtkCPDataDescription.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkCPDataDescription_h
#define vtkCPDataDescription_h
 
#include "vtkObject.h"
#include "vtkPVCatalystModule.h" // needed for exports
 
class vtkFieldData;
class vtkCPInputDataDescription;
 
class VTKPVCATALYST_EXPORT vtkCPDataDescription : public vtkObject
{
public:
  static vtkCPDataDescription* New();
  vtkTypeMacro(vtkCPDataDescription, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  void SetTimeData(double time, vtkIdType timeStep);
 
  vtkGetMacro(TimeStep, vtkIdType);
 
  vtkGetMacro(Time, double);
 
  vtkSetMacro(ForceOutput, bool);
 
  vtkBooleanMacro(ForceOutput, bool);
 
  vtkGetMacro(ForceOutput, bool);
 
  void AddInput(const char* gridName);
 
  unsigned int GetNumberOfInputDescriptions();
 
  void ResetInputDescriptions();
 
  void ResetAll();
 
  vtkCPInputDataDescription* GetInputDescription(unsigned int);
 
  const char* GetInputDescriptionName(unsigned int);
 
  vtkCPInputDataDescription* GetInputDescriptionByName(const char*);
 
  bool GetIfGridIsNecessary(const char*);
 
  bool GetIfAnyGridNecessary();
 
  void SetUserData(vtkFieldData* UserData);
 
  vtkGetObjectMacro(UserData, vtkFieldData);
 
  void Copy(vtkCPDataDescription*);
 
protected:
  vtkCPDataDescription();
  ~vtkCPDataDescription() override;
 
private:
  vtkCPDataDescription(const vtkCPDataDescription&) = delete;
  void operator=(const vtkCPDataDescription&) = delete;
 
  double Time;
 
  vtkIdType TimeStep;
 
  bool IsTimeDataSet;
 
  bool ForceOutput;
 
  vtkFieldData* UserData;
 
  class vtkInternals;
  vtkInternals* Internals;
};
 
#endif