vtkNetCDFReader.h

Go to the documentation of this file.

// -*- c++ -*-
/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkNetCDFReader.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm 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.
 
=========================================================================*/
 
/*-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
 
#ifndef vtkNetCDFReader_h
#define vtkNetCDFReader_h
 
#include "vtkDataObjectAlgorithm.h"
#include "vtkIONetCDFModule.h" // For export macro
 
#include "vtkSmartPointer.h" // For ivars
#include <string>            //For std::string
 
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);
 
  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);
 
private:
  vtkNetCDFReader(const vtkNetCDFReader&) = delete;
  void operator=(const vtkNetCDFReader&) = delete;
 
  int UpdateExtent[6];
  char* TimeUnits;
  char* Calendar;
  vtkNetCDFReaderPrivate* Private;
};
 
#endif // vtkNetCDFReader_h