vtkCPDataDescription.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ParaView
  Module:    vtkCPDataDescription.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#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();
  virtual ~vtkCPDataDescription();

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