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 "vtkIONetCDFModule.h" // For export macro
#include "vtkDataObjectAlgorithm.h"
 
#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();
  virtual void PrintSelf(ostream &os, vtkIndent indent);
 
  virtual void SetFileName(const char *filename);
  vtkGetStringMacro(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 idx);
  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);
 
 
  vtkGetObjectMacro(AllDimensions, vtkStringArray);
 
 
  vtkGetMacro(ReplaceFillValueWithNan, int);
  vtkSetMacro(ReplaceFillValueWithNan, int);
  vtkBooleanMacro(ReplaceFillValueWithNan, int);
 
 
  vtkGetStringMacro(TimeUnits);
  vtkGetStringMacro(Calendar);
 
  std::string QueryArrayUnits(const char *ArrayName);
 
protected:
  vtkNetCDFReader();
  ~vtkNetCDFReader();
 
  char *FileName;
  vtkTimeStamp FileNameMTime;
  vtkTimeStamp MetaDataMTime;
 
//BTX
  vtkSmartPointer<vtkIntArray> LoadingDimensions;
 
  vtkSmartPointer<vtkDataArraySelection> VariableArraySelection;
 
  vtkSmartPointer<vtkStringArray> AllVariableArrayNames;
 
  vtkStringArray *VariableDimensions;
 
 
  vtkStringArray *AllDimensions;
//ETX
 
  int ReplaceFillValueWithNan;
 
  int WholeExtent[6];
 
  virtual int RequestDataObject(vtkInformation *request,
                                vtkInformationVector **inputVector,
                                vtkInformationVector *outputVector);
 
  virtual int RequestInformation(vtkInformation *request,
                                 vtkInformationVector **inputVector,
                                 vtkInformationVector *outputVector);
 
  virtual int RequestData(vtkInformation *request,
                          vtkInformationVector **inputVector,
                          vtkInformationVector *outputVector);
 
 
  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);
 
//BTX
 
  virtual vtkSmartPointer<vtkDoubleArray> GetTimeValues(int ncFD, int dimId);
//ETX
 
 
  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 &);     // Not implemented
  void operator=(const vtkNetCDFReader &);      // Not implemented
 
  int UpdateExtent[6];
  char *TimeUnits;
  char *Calendar;
  vtkNetCDFReaderPrivate *Private;
};
 
#endif //vtkNetCDFReader_h