VTK
vtkDelimitedTextReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkDelimitedTextReader.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm 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 =========================================================================*/
15 /*-------------------------------------------------------------------------
16  Copyright 2008 Sandia Corporation.
17  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18  the U.S. Government retains certain rights in this software.
19 -------------------------------------------------------------------------*/
20 
21 
64 #ifndef vtkDelimitedTextReader_h
65 #define vtkDelimitedTextReader_h
66 
67 #include "vtkIOInfovisModule.h" // For export macro
68 #include "vtkTableAlgorithm.h"
69 #include "vtkUnicodeString.h" // Needed for vtkUnicodeString
70 #include "vtkStdString.h" // Needed for vtkStdString
71 
72 class VTKIOINFOVIS_EXPORT vtkDelimitedTextReader : public vtkTableAlgorithm
73 {
74 public:
75  static vtkDelimitedTextReader* New();
77  void PrintSelf(ostream& os, vtkIndent indent) override;
78 
80 
83  vtkGetStringMacro(FileName);
84  vtkSetStringMacro(FileName);
86 
88 
94  void SetInputString(const char *in);
95  vtkGetStringMacro(InputString);
96  void SetInputString(const char *in, int len);
97  vtkGetMacro(InputStringLength, int);
98  void SetInputString(const vtkStdString& input)
99  { this->SetInputString(input.c_str(), static_cast<int>(input.length())); }
101 
103 
107  vtkSetMacro(ReadFromInputString,vtkTypeBool);
108  vtkGetMacro(ReadFromInputString,vtkTypeBool);
109  vtkBooleanMacro(ReadFromInputString,vtkTypeBool);
111 
113 
124  vtkGetStringMacro(UnicodeCharacterSet);
125  vtkSetStringMacro(UnicodeCharacterSet);
127 
129 
134  void SetUTF8RecordDelimiters(const char* delimiters);
135  const char* GetUTF8RecordDelimiters();
136  void SetUnicodeRecordDelimiters(const vtkUnicodeString& delimiters);
137  vtkUnicodeString GetUnicodeRecordDelimiters();
139 
141 
148  vtkSetStringMacro(FieldDelimiterCharacters);
149  vtkGetStringMacro(FieldDelimiterCharacters);
151 
152  void SetUTF8FieldDelimiters(const char* delimiters);
153  const char* GetUTF8FieldDelimiters();
154  void SetUnicodeFieldDelimiters(const vtkUnicodeString& delimiters);
155  vtkUnicodeString GetUnicodeFieldDelimiters();
156 
158 
167  vtkGetMacro(StringDelimiter, char);
168  vtkSetMacro(StringDelimiter, char);
170 
171  void SetUTF8StringDelimiters(const char* delimiters);
172  const char* GetUTF8StringDelimiters();
173  void SetUnicodeStringDelimiters(const vtkUnicodeString& delimiters);
174  vtkUnicodeString GetUnicodeStringDelimiters();
175 
177 
180  vtkSetMacro(UseStringDelimiter, bool);
181  vtkGetMacro(UseStringDelimiter, bool);
182  vtkBooleanMacro(UseStringDelimiter, bool);
184 
186 
190  vtkGetMacro(HaveHeaders, bool);
191  vtkSetMacro(HaveHeaders, bool);
193 
195 
200  vtkSetMacro(MergeConsecutiveDelimiters, bool);
201  vtkGetMacro(MergeConsecutiveDelimiters, bool);
202  vtkBooleanMacro(MergeConsecutiveDelimiters, bool);
204 
206 
210  vtkGetMacro(MaxRecords, vtkIdType);
211  vtkSetMacro(MaxRecords, vtkIdType);
213 
215 
220  vtkSetMacro(DetectNumericColumns, bool);
221  vtkGetMacro(DetectNumericColumns, bool);
222  vtkBooleanMacro(DetectNumericColumns, bool);
224 
226 
231  vtkSetMacro(ForceDouble, bool);
232  vtkGetMacro(ForceDouble, bool);
233  vtkBooleanMacro(ForceDouble, bool);
235 
237 
252  vtkSetMacro(TrimWhitespacePriorToNumericConversion, bool);
253  vtkGetMacro(TrimWhitespacePriorToNumericConversion, bool);
254  vtkBooleanMacro(TrimWhitespacePriorToNumericConversion, bool);
256 
258 
262  vtkSetMacro(DefaultIntegerValue, int);
263  vtkGetMacro(DefaultIntegerValue, int);
265 
267 
271  vtkSetMacro(DefaultDoubleValue, double);
272  vtkGetMacro(DefaultDoubleValue, double);
274 
276 
280  vtkSetStringMacro(PedigreeIdArrayName);
281  vtkGetStringMacro(PedigreeIdArrayName);
283 
285 
289  vtkSetMacro(GeneratePedigreeIds, bool);
290  vtkGetMacro(GeneratePedigreeIds, bool);
291  vtkBooleanMacro(GeneratePedigreeIds, bool);
293 
295 
298  vtkSetMacro(OutputPedigreeIds, bool);
299  vtkGetMacro(OutputPedigreeIds, bool);
300  vtkBooleanMacro(OutputPedigreeIds, bool);
302 
304 
309  vtkSetMacro(AddTabFieldDelimiter, bool);
310  vtkGetMacro(AddTabFieldDelimiter, bool);
311  vtkBooleanMacro(AddTabFieldDelimiter, bool);
313 
319  vtkStdString GetLastError();
320 
322 
327  vtkSetMacro(ReplacementCharacter, vtkTypeUInt32);
328  vtkGetMacro(ReplacementCharacter, vtkTypeUInt32);
330 
331 protected:
333  ~vtkDelimitedTextReader() override;
334 
335  int RequestData(
338  vtkInformationVector*) override;
339 
340  char* FileName;
342  char *InputString;
367  vtkTypeUInt32 ReplacementCharacter;
368 
369 private:
371  void operator=(const vtkDelimitedTextReader&) = delete;
372 
373 };
374 
375 #endif
vtkDelimitedTextReader::OutputPedigreeIds
bool OutputPedigreeIds
Definition: vtkDelimitedTextReader.h:364
vtkStdString.h
vtkTableAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkDelimitedTextReader::DetectNumericColumns
bool DetectNumericColumns
Definition: vtkDelimitedTextReader.h:351
vtkDelimitedTextReader::InputString
char * InputString
Definition: vtkDelimitedTextReader.h:342
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkDelimitedTextReader::GeneratePedigreeIds
bool GeneratePedigreeIds
Definition: vtkDelimitedTextReader.h:363
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:35
vtkDelimitedTextReader::UnicodeWhitespace
vtkUnicodeString UnicodeWhitespace
Definition: vtkDelimitedTextReader.h:349
vtkUnicodeString.h
vtkDelimitedTextReader::FieldDelimiterCharacters
char * FieldDelimiterCharacters
Definition: vtkDelimitedTextReader.h:356
vtkDelimitedTextReader::ReadFromInputString
vtkTypeBool ReadFromInputString
Definition: vtkDelimitedTextReader.h:341
vtkDelimitedTextReader::UnicodeEscapeCharacter
vtkUnicodeString UnicodeEscapeCharacter
Definition: vtkDelimitedTextReader.h:350
vtkDelimitedTextReader::UnicodeFieldDelimiters
vtkUnicodeString UnicodeFieldDelimiters
Definition: vtkDelimitedTextReader.h:347
vtkDelimitedTextReader::DefaultDoubleValue
double DefaultDoubleValue
Definition: vtkDelimitedTextReader.h:355
vtkDelimitedTextReader::UnicodeCharacterSet
char * UnicodeCharacterSet
Definition: vtkDelimitedTextReader.h:344
vtkDelimitedTextReader::LastError
vtkStdString LastError
Definition: vtkDelimitedTextReader.h:366
vtkDelimitedTextReader::StringDelimiter
char StringDelimiter
Definition: vtkDelimitedTextReader.h:357
vtkDelimitedTextReader::DefaultIntegerValue
int DefaultIntegerValue
Definition: vtkDelimitedTextReader.h:354
vtkDelimitedTextReader::SetInputString
void SetInputString(const vtkStdString &input)
Definition: vtkDelimitedTextReader.h:98
vtkDelimitedTextReader::InputStringLength
int InputStringLength
Definition: vtkDelimitedTextReader.h:343
vtkTableAlgorithm
Superclass for algorithms that produce only vtkTables as output.
Definition: vtkTableAlgorithm.h:48
vtkDelimitedTextReader::HaveHeaders
bool HaveHeaders
Definition: vtkDelimitedTextReader.h:359
vtkDelimitedTextReader::UseStringDelimiter
bool UseStringDelimiter
Definition: vtkDelimitedTextReader.h:358
vtkDelimitedTextReader::UnicodeOutputArrays
bool UnicodeOutputArrays
Definition: vtkDelimitedTextReader.h:360
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkUnicodeString
String class that stores Unicode text.
Definition: vtkUnicodeString.h:69
vtkDelimitedTextReader::UnicodeRecordDelimiters
vtkUnicodeString UnicodeRecordDelimiters
Definition: vtkDelimitedTextReader.h:346
vtkDelimitedTextReader::UnicodeStringDelimiters
vtkUnicodeString UnicodeStringDelimiters
Definition: vtkDelimitedTextReader.h:348
vtkDelimitedTextReader::FileName
char * FileName
Definition: vtkDelimitedTextReader.h:340
vtkDelimitedTextReader
reads in delimited ascii or unicode text files and outputs a vtkTable data structure.
Definition: vtkDelimitedTextReader.h:72
vtkDelimitedTextReader::MaxRecords
vtkIdType MaxRecords
Definition: vtkDelimitedTextReader.h:345
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:80
vtkDelimitedTextReader::MergeConsecutiveDelimiters
bool MergeConsecutiveDelimiters
Definition: vtkDelimitedTextReader.h:361
vtkTableAlgorithm.h
vtkDelimitedTextReader::TrimWhitespacePriorToNumericConversion
bool TrimWhitespacePriorToNumericConversion
Definition: vtkDelimitedTextReader.h:353
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:34
vtkDelimitedTextReader::ForceDouble
bool ForceDouble
Definition: vtkDelimitedTextReader.h:352
vtkDelimitedTextReader::AddTabFieldDelimiter
bool AddTabFieldDelimiter
Definition: vtkDelimitedTextReader.h:365
vtkTableAlgorithm::RequestData
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called by the superclass.
vtkDelimitedTextReader::ReplacementCharacter
vtkTypeUInt32 ReplacementCharacter
Definition: vtkDelimitedTextReader.h:367
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkDelimitedTextReader::PedigreeIdArrayName
char * PedigreeIdArrayName
Definition: vtkDelimitedTextReader.h:362
vtkTableAlgorithm::New
static vtkTableAlgorithm * New()