vtkStructuredPointsReader.h 2.62 KB
Newer Older
Will Schroeder's avatar
Will Schroeder committed
1 2
/*=========================================================================

Ken Martin's avatar
Ken Martin committed
3
  Program:   Visualization Toolkit
Ken Martin's avatar
Ken Martin committed
4
  Module:    vtkStructuredPointsReader.h
Will Schroeder's avatar
Will Schroeder committed
5

6
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 8
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
Ken Martin's avatar
Ken Martin committed
9

10 11
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12
     PURPOSE.  See the above copyright notice for more information.
Will Schroeder's avatar
Will Schroeder committed
13 14

=========================================================================*/
Ken Martin's avatar
Ken Martin committed
15
// .NAME vtkStructuredPointsReader - read vtk structured points data file
Will Schroeder's avatar
Will Schroeder committed
16
// .SECTION Description
Ken Martin's avatar
Ken Martin committed
17
// vtkStructuredPointsReader is a source object that reads ASCII or binary 
18 19 20 21 22
// structured points data files in vtk format (see text for format details).
// The output of this reader is a single vtkStructuredPoints data object.
// The superclass of this class, vtkDataReader, provides many methods for
// controlling the reading of the data file, see vtkDataReader for more
// information.
Will Schroeder's avatar
Will Schroeder committed
23 24
// .SECTION Caveats
// Binary files written on one system may not be readable on other systems.
25 26
// .SECTION See Also
// vtkStructuredPoints vtkDataReader
Will Schroeder's avatar
Will Schroeder committed
27

Ken Martin's avatar
Ken Martin committed
28 29
#ifndef __vtkStructuredPointsReader_h
#define __vtkStructuredPointsReader_h
Will Schroeder's avatar
Will Schroeder committed
30

Ken Martin's avatar
Ken Martin committed
31
#include "vtkDataReader.h"
32 33

class vtkStructuredPoints;
Will Schroeder's avatar
Will Schroeder committed
34

35
class VTK_IO_EXPORT vtkStructuredPointsReader : public vtkDataReader
Will Schroeder's avatar
Will Schroeder committed
36 37
{
public:
38
  static vtkStructuredPointsReader *New();
Brad King's avatar
Brad King committed
39
  vtkTypeRevisionMacro(vtkStructuredPointsReader,vtkDataReader);
40
  void PrintSelf(ostream& os, vtkIndent indent);
Will Schroeder's avatar
Will Schroeder committed
41

Ken Martin's avatar
Ken Martin committed
42
  // Description:
43 44
  // Set/Get the output of this reader.
  void SetOutput(vtkStructuredPoints *output);
45
  vtkStructuredPoints *GetOutput(int idx);
46
  vtkStructuredPoints *GetOutput();
Ken Martin's avatar
Ken Martin committed
47
  
48 49 50 51 52
  // Description:
  // Read the meta information from the file.  This needs to be public to it
  // can be accessed by vtkDataSetReader.
  virtual int ReadMetaData(vtkInformation *outInfo);

Will Schroeder's avatar
Will Schroeder committed
53
protected:
54 55
  vtkStructuredPointsReader();
  ~vtkStructuredPointsReader();
56

57 58
  virtual int RequestData(vtkInformation *, vtkInformationVector **,
                          vtkInformationVector *);
59 60 61

  // Default method performs Update to get information.  Not all the old
  // structured points sources compute information
62 63
  virtual int RequestInformation(vtkInformation *, vtkInformationVector **,
                                 vtkInformationVector *);
64

65
  virtual int FillOutputPortInformation(int, vtkInformation *);
66 67 68
private:
  vtkStructuredPointsReader(const vtkStructuredPointsReader&);  // Not implemented.
  void operator=(const vtkStructuredPointsReader&);  // Not implemented.
Will Schroeder's avatar
Will Schroeder committed
69 70 71 72 73
};

#endif