ParaView
vtkCSVExporter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkCSVExporter.h
5 
6  Copyright (c) Kitware, Inc.
7  All rights reserved.
8  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
39 #ifndef vtkCSVExporter_h
40 #define vtkCSVExporter_h
41 
42 #include "vtkObject.h"
43 #include "vtkPVVTKExtensionsRenderingModule.h" // needed for export macro
44 
45 class vtkAbstractArray;
46 class vtkDataArray;
47 class vtkFieldData;
48 
49 class VTKPVVTKEXTENSIONSRENDERING_EXPORT vtkCSVExporter : public vtkObject
50 {
51 public:
52  static vtkCSVExporter* New();
53  vtkTypeMacro(vtkCSVExporter, vtkObject);
54  void PrintSelf(ostream& os, vtkIndent indent);
55 
57 
60  vtkSetStringMacro(FileName);
61  vtkGetStringMacro(FileName);
63 
65 
68  vtkSetStringMacro(FieldDelimiter);
69  vtkGetStringMacro(FieldDelimiter);
71 
73 
76  vtkSetMacro(FilterColumnsByVisibility, bool);
77  vtkGetMacro(FilterColumnsByVisibility, bool);
79 
81  {
83  STREAM_COLUMNS
84  };
85 
89  bool Open(ExporterModes mode = STREAM_ROWS);
90 
95  void Close();
96 
101  void Abort();
102 
104 
109  void WriteHeader(vtkFieldData*);
110  void WriteData(vtkFieldData*);
112 
120  void AddColumn(
121  vtkAbstractArray* yarray, const char* yarrayname = NULL, vtkDataArray* xarray = NULL);
122 
123 protected:
124  vtkCSVExporter();
125  ~vtkCSVExporter();
126 
127  char* FileName;
130  ofstream* FileStream;
132 
133 private:
134  vtkCSVExporter(const vtkCSVExporter&) VTK_DELETE_FUNCTION;
135  void operator=(const vtkCSVExporter&) VTK_DELETE_FUNCTION;
136 
137  class vtkInternals;
138  vtkInternals* Internals;
139 };
140 
141 #endif
ofstream * FileStream
ExporterModes Mode
exporter used by certain views to export data as a CSV file.
bool FilterColumnsByVisibility