vtkNetCDFReader.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-LANL-California-USGov

#ifndef vtkNetCDFReader_h
#define vtkNetCDFReader_h

#include "vtkDataObjectAlgorithm.h"
#include "vtkIONetCDFModule.h" // For export macro
#include "vtkNetCDFAccessor.h" // For netcdf/xarray accessor

#include "vtkSmartPointer.h" // For ivars
#include <string>            //For std::string

VTK_ABI_NAMESPACE_BEGIN
class vtkDataArraySelection;
class vtkDataSet;
class vtkDoubleArray;
class vtkIntArray;
class vtkStdString;
class vtkStringArray;
class vtkNetCDFReaderPrivate;

class VTKIONETCDF_EXPORT vtkNetCDFReader : public vtkDataObjectAlgorithm
{
public:
  vtkTypeMacro(vtkNetCDFReader, vtkDataObjectAlgorithm);
  static vtkNetCDFReader* New();
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual void SetFileName(VTK_FILEPATH const char* filename);
  vtkGetFilePathMacro(FileName);
  vtkSetObjectMacro(Accessor, vtkNetCDFAccessor);
  vtkGetObjectMacro(Accessor, vtkNetCDFAccessor);

  int UpdateMetaData();

  //   // Description:
  //   // Get the data array selection tables used to configure which variables to
  //   // load.
  //   vtkGetObjectMacro(VariableArraySelection, vtkDataArraySelection);


  virtual int GetNumberOfVariableArrays();
  virtual const char* GetVariableArrayName(int index);
  virtual int GetVariableArrayStatus(const char* name);
  virtual void SetVariableArrayStatus(const char* name, int status);

  virtual vtkStringArray* GetAllVariableArrayNames();


  vtkGetObjectMacro(VariableDimensions, vtkStringArray);

  virtual void SetDimensions(const char* dimensions);

  bool ComputeArraySelection();


  vtkGetObjectMacro(AllDimensions, vtkStringArray);


  vtkGetMacro(ReplaceFillValueWithNan, vtkTypeBool);
  vtkSetMacro(ReplaceFillValueWithNan, vtkTypeBool);
  vtkBooleanMacro(ReplaceFillValueWithNan, vtkTypeBool);


  vtkGetStringMacro(TimeUnits);
  vtkGetStringMacro(Calendar);

  std::string QueryArrayUnits(const char* ArrayName);

protected:
  vtkNetCDFReader();
  ~vtkNetCDFReader() override;

  char* FileName;
  vtkTimeStamp FileNameMTime;
  vtkTimeStamp MetaDataMTime;

  vtkSmartPointer<vtkIntArray> LoadingDimensions;

  vtkSmartPointer<vtkDataArraySelection> VariableArraySelection;

  vtkSmartPointer<vtkStringArray> AllVariableArrayNames;

  vtkStringArray* VariableDimensions;

  std::string CurrentDimensions;

  vtkStringArray* AllDimensions;

  vtkTypeBool ReplaceFillValueWithNan;

  int WholeExtent[6];

  int RequestDataObject(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  static void SelectionModifiedCallback(
    vtkObject* caller, unsigned long eid, void* clientdata, void* calldata);

  vtkStdString DescribeDimensions(int ncFD, const int* dimIds, int numDims);

  virtual int ReadMetaData(int ncFD);

  virtual int FillVariableDimensions(int ncFD);

  virtual int IsTimeDimension(int ncFD, int dimId);

  virtual vtkSmartPointer<vtkDoubleArray> GetTimeValues(int ncFD, int dimId);

  virtual bool DimensionsAreForPointData(vtkIntArray* vtkNotUsed(dimensions)) { return true; }

  virtual void GetUpdateExtentForOutput(vtkDataSet* output, int extent[6]);

  virtual int LoadVariable(int ncFD, const char* varName, double time, vtkDataSet* output);

  vtkNetCDFAccessor* Accessor;

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

  int UpdateExtent[6];
  char* TimeUnits;
  char* Calendar;
  vtkNetCDFReaderPrivate* Private;
};

VTK_ABI_NAMESPACE_END
#endif // vtkNetCDFReader_h