VTK  9.4.2
vtkDelimitedTextReader.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
3// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
4
89#ifndef vtkDelimitedTextReader_h
90#define vtkDelimitedTextReader_h
91
92#include "vtkIOInfovisModule.h" // For export macro
93#include "vtkStdString.h" // Needed for vtkStdString
94#include "vtkTableAlgorithm.h"
95
96#include <memory>
97#include <string>
98
99VTK_ABI_NAMESPACE_BEGIN
100
101class vtkTextCodec;
102
103class VTKIOINFOVIS_EXPORT vtkDelimitedTextReader : public vtkTableAlgorithm
104{
105public:
108 void PrintSelf(ostream& os, vtkIndent indent) override;
109
111
117
119
125 void SetInputString(const char* in);
126 vtkGetStringMacro(InputString);
127 void SetInputString(const char* in, int len);
128 vtkGetMacro(InputStringLength, int);
129 void SetInputString(const vtkStdString& input)
130 {
131 this->SetInputString(input.c_str(), static_cast<int>(input.length()));
132 }
134
136
140 vtkSetMacro(ReadFromInputString, vtkTypeBool);
141 vtkGetMacro(ReadFromInputString, vtkTypeBool);
142 vtkBooleanMacro(ReadFromInputString, vtkTypeBool);
144
146
157 vtkGetStringMacro(UnicodeCharacterSet);
158 vtkSetStringMacro(UnicodeCharacterSet);
160
162
167 void SetUTF8RecordDelimiters(const char* delimiters);
170
172
179 vtkSetStringMacro(FieldDelimiterCharacters);
180 vtkGetStringMacro(FieldDelimiterCharacters);
182
183 void SetUTF8FieldDelimiters(const char* delimiters);
185
187
196 vtkGetMacro(StringDelimiter, char);
197 vtkSetMacro(StringDelimiter, char);
199
200 void SetUTF8StringDelimiters(const char* delimiters);
202
204
207 vtkSetMacro(UseStringDelimiter, bool);
208 vtkGetMacro(UseStringDelimiter, bool);
209 vtkBooleanMacro(UseStringDelimiter, bool);
211
213
217 vtkGetMacro(HaveHeaders, bool);
218 vtkSetMacro(HaveHeaders, bool);
220
222
227 vtkSetMacro(MergeConsecutiveDelimiters, bool);
228 vtkGetMacro(MergeConsecutiveDelimiters, bool);
229 vtkBooleanMacro(MergeConsecutiveDelimiters, bool);
231
233
237 vtkGetMacro(MaxRecords, vtkIdType);
238 vtkSetMacro(MaxRecords, vtkIdType);
240
242
251 vtkSetMacro(DetectNumericColumns, bool);
252 vtkGetMacro(DetectNumericColumns, bool);
253 vtkBooleanMacro(DetectNumericColumns, bool);
255
257
262 vtkSetMacro(ForceDouble, bool);
263 vtkGetMacro(ForceDouble, bool);
264 vtkBooleanMacro(ForceDouble, bool);
266
268
283 vtkSetMacro(TrimWhitespacePriorToNumericConversion, bool);
284 vtkGetMacro(TrimWhitespacePriorToNumericConversion, bool);
285 vtkBooleanMacro(TrimWhitespacePriorToNumericConversion, bool);
287
289
293 vtkSetMacro(DefaultIntegerValue, int);
294 vtkGetMacro(DefaultIntegerValue, int);
296
298
302 vtkSetMacro(DefaultDoubleValue, double);
303 vtkGetMacro(DefaultDoubleValue, double);
305
307
311 vtkSetStringMacro(PedigreeIdArrayName);
312 vtkGetStringMacro(PedigreeIdArrayName);
314
316
320 vtkSetMacro(GeneratePedigreeIds, bool);
321 vtkGetMacro(GeneratePedigreeIds, bool);
322 vtkBooleanMacro(GeneratePedigreeIds, bool);
324
326
329 vtkSetMacro(OutputPedigreeIds, bool);
330 vtkGetMacro(OutputPedigreeIds, bool);
331 vtkBooleanMacro(OutputPedigreeIds, bool);
333
335
340 vtkSetMacro(AddTabFieldDelimiter, bool);
341 vtkGetMacro(AddTabFieldDelimiter, bool);
342 vtkBooleanMacro(AddTabFieldDelimiter, bool);
344
351
353
358 vtkSetMacro(ReplacementCharacter, vtkTypeUInt32);
359 vtkGetMacro(ReplacementCharacter, vtkTypeUInt32);
361
362protected:
365
367
368 // Read the content of the input file.
369 int ReadData(vtkTable* output_table);
370
371 char* FileName = nullptr;
372 vtkTypeBool ReadFromInputString = 0;
373 char* InputString = nullptr;
374 int InputStringLength = 0;
375 char* UnicodeCharacterSet = nullptr;
376 vtkIdType MaxRecords = 0;
377 std::string UnicodeRecordDelimiters = "\r\n";
378 std::string UnicodeFieldDelimiters = ",";
379 std::string UnicodeStringDelimiters = "\"";
380 std::string UnicodeWhitespace = " \t\r\n\v\f";
381 std::string UnicodeEscapeCharacter = "\\";
382 bool DetectNumericColumns = false;
383 bool ForceDouble = false;
384 bool TrimWhitespacePriorToNumericConversion = false;
385 int DefaultIntegerValue = 0;
386 double DefaultDoubleValue = 0.;
387 char* FieldDelimiterCharacters = nullptr;
388 char StringDelimiter = '"';
389 bool UseStringDelimiter = true;
390 bool HaveHeaders = false;
391 bool MergeConsecutiveDelimiters = false;
392 char* PedigreeIdArrayName = nullptr;
393 bool GeneratePedigreeIds = true;
394 bool OutputPedigreeIds = false;
395 bool AddTabFieldDelimiter = false;
396 vtkStdString LastError = "";
397 vtkTypeUInt32 ReplacementCharacter = 'x';
398
399private:
404 std::unique_ptr<std::istream> OpenStream();
405
410 void ReadBOM(std::istream* stream);
411
416 vtkTextCodec* CreateTextCodec(std::istream* input_stream);
417
419 void operator=(const vtkDelimitedTextReader&) = delete;
420};
421
422VTK_ABI_NAMESPACE_END
423#endif
reads in delimited ascii or unicode text files and outputs a vtkTable data structure.
void SetInputString(const char *in, int len)
Specify the InputString for use when reading from a character array.
int ReadData(vtkTable *output_table)
~vtkDelimitedTextReader() override
void SetUTF8RecordDelimiters(const char *delimiters)
Specify the character(s) that will be used to separate records.
vtkStdString GetLastError()
Returns a human-readable description of the most recent error, if any.
void SetInputString(const char *in)
Specify the InputString for use when reading from a character array.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
void SetUTF8StringDelimiters(const char *delimiters)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkGetFilePathMacro(FileName)
Specifies the delimited text file to be loaded.
const char * GetUTF8StringDelimiters()
vtkSetFilePathMacro(FileName)
Specifies the delimited text file to be loaded.
static vtkDelimitedTextReader * New()
const char * GetUTF8RecordDelimiters()
Specify the character(s) that will be used to separate records.
void SetInputString(const vtkStdString &input)
Specify the InputString for use when reading from a character array.
const char * GetUTF8FieldDelimiters()
void SetUTF8FieldDelimiters(const char *delimiters)
a simple class to control print indentation
Definition vtkIndent.h:108
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Wrapper around std::string to keep symbols short.
Superclass for algorithms that produce only vtkTables as output.
A table, which contains similar-typed columns of data.
Definition vtkTable.h:169
Virtual class to act as an interface for all text codecs.
int vtkTypeBool
Definition vtkABI.h:64
int vtkIdType
Definition vtkType.h:315