VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkDelimitedTextReader Class Reference

reads in delimited ascii or unicode text files and outputs a vtkTable data structure. More...

#include <vtkDelimitedTextReader.h>

Inheritance diagram for vtkDelimitedTextReader:
[legend]
Collaboration diagram for vtkDelimitedTextReader:
[legend]

Public Types

typedef vtkTableAlgorithm Superclass
 
- Public Types inherited from vtkTableAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkDelimitedTextReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void SetUTF8FieldDelimiters (const char *delimiters)
 
const char * GetUTF8FieldDelimiters ()
 
void SetUnicodeFieldDelimiters (const vtkUnicodeString &delimiters)
 
vtkUnicodeString GetUnicodeFieldDelimiters ()
 
void SetUTF8StringDelimiters (const char *delimiters)
 
const char * GetUTF8StringDelimiters ()
 
void SetUnicodeStringDelimiters (const vtkUnicodeString &delimiters)
 
vtkUnicodeString GetUnicodeStringDelimiters ()
 
vtkStdString GetLastError ()
 Returns a human-readable description of the most recent error, if any.
 
 vtkGetFilePathMacro (FileName)
 Specifies the delimited text file to be loaded.
 
 vtkSetFilePathMacro (FileName)
 Specifies the delimited text file to be loaded.
 
void SetInputString (const char *in)
 Specify the InputString for use when reading from a character array.
 
virtual char * GetInputString ()
 Specify the InputString for use when reading from a character array.
 
void SetInputString (const char *in, int len)
 Specify the InputString for use when reading from a character array.
 
virtual int GetInputStringLength ()
 Specify the InputString for use when reading from a character array.
 
void SetInputString (const vtkStdString &input)
 Specify the InputString for use when reading from a character array.
 
virtual void SetReadFromInputString (vtkTypeBool)
 Enable reading from an InputString or InputArray instead of the default, a file.
 
virtual vtkTypeBool GetReadFromInputString ()
 Enable reading from an InputString or InputArray instead of the default, a file.
 
virtual void ReadFromInputStringOn ()
 Enable reading from an InputString or InputArray instead of the default, a file.
 
virtual void ReadFromInputStringOff ()
 Enable reading from an InputString or InputArray instead of the default, a file.
 
virtual char * GetUnicodeCharacterSet ()
 Specifies the character set used in the input file.
 
virtual void SetUnicodeCharacterSet (const char *)
 Specifies the character set used in the input file.
 
void SetUTF8RecordDelimiters (const char *delimiters)
 Specify the character(s) that will be used to separate records.
 
const char * GetUTF8RecordDelimiters ()
 Specify the character(s) that will be used to separate records.
 
void SetUnicodeRecordDelimiters (const vtkUnicodeString &delimiters)
 Specify the character(s) that will be used to separate records.
 
vtkUnicodeString GetUnicodeRecordDelimiters ()
 Specify the character(s) that will be used to separate records.
 
virtual void SetFieldDelimiterCharacters (const char *)
 Specify the character(s) that will be used to separate fields.
 
virtual char * GetFieldDelimiterCharacters ()
 Specify the character(s) that will be used to separate fields.
 
virtual char GetStringDelimiter ()
 Get/set the character that will begin and end strings.
 
virtual void SetStringDelimiter (char)
 Get/set the character that will begin and end strings.
 
virtual void SetUseStringDelimiter (bool)
 Set/get whether to use the string delimiter.
 
virtual bool GetUseStringDelimiter ()
 Set/get whether to use the string delimiter.
 
virtual void UseStringDelimiterOn ()
 Set/get whether to use the string delimiter.
 
virtual void UseStringDelimiterOff ()
 Set/get whether to use the string delimiter.
 
virtual bool GetHaveHeaders ()
 Set/get whether to treat the first line of the file as headers.
 
virtual void SetHaveHeaders (bool)
 Set/get whether to treat the first line of the file as headers.
 
virtual void SetMergeConsecutiveDelimiters (bool)
 Set/get whether to merge successive delimiters.
 
virtual bool GetMergeConsecutiveDelimiters ()
 Set/get whether to merge successive delimiters.
 
virtual void MergeConsecutiveDelimitersOn ()
 Set/get whether to merge successive delimiters.
 
virtual void MergeConsecutiveDelimitersOff ()
 Set/get whether to merge successive delimiters.
 
virtual vtkIdType GetMaxRecords ()
 Specifies the maximum number of records to read from the file.
 
virtual void SetMaxRecords (vtkIdType)
 Specifies the maximum number of records to read from the file.
 
virtual void SetDetectNumericColumns (bool)
 When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray.
 
virtual bool GetDetectNumericColumns ()
 When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray.
 
virtual void DetectNumericColumnsOn ()
 When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray.
 
virtual void DetectNumericColumnsOff ()
 When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray.
 
virtual void SetForceDouble (bool)
 When set to true and DetectNumericColumns is also true, forces all numeric columns to vtkDoubleArray even if they contain only integer values.
 
virtual bool GetForceDouble ()
 When set to true and DetectNumericColumns is also true, forces all numeric columns to vtkDoubleArray even if they contain only integer values.
 
virtual void ForceDoubleOn ()
 When set to true and DetectNumericColumns is also true, forces all numeric columns to vtkDoubleArray even if they contain only integer values.
 
virtual void ForceDoubleOff ()
 When set to true and DetectNumericColumns is also true, forces all numeric columns to vtkDoubleArray even if they contain only integer values.
 
virtual void SetTrimWhitespacePriorToNumericConversion (bool)
 When DetectNumericColumns is set to true, whether to trim whitespace from strings prior to conversion to a numeric.
 
virtual bool GetTrimWhitespacePriorToNumericConversion ()
 When DetectNumericColumns is set to true, whether to trim whitespace from strings prior to conversion to a numeric.
 
virtual void TrimWhitespacePriorToNumericConversionOn ()
 When DetectNumericColumns is set to true, whether to trim whitespace from strings prior to conversion to a numeric.
 
virtual void TrimWhitespacePriorToNumericConversionOff ()
 When DetectNumericColumns is set to true, whether to trim whitespace from strings prior to conversion to a numeric.
 
virtual void SetDefaultIntegerValue (int)
 When DetectNumericColumns is set to true, the reader use this value to populate the vtkIntArray where empty strings are found.
 
virtual int GetDefaultIntegerValue ()
 When DetectNumericColumns is set to true, the reader use this value to populate the vtkIntArray where empty strings are found.
 
virtual void SetDefaultDoubleValue (double)
 When DetectNumericColumns is set to true, the reader use this value to populate the vtkDoubleArray where empty strings are found.
 
virtual double GetDefaultDoubleValue ()
 When DetectNumericColumns is set to true, the reader use this value to populate the vtkDoubleArray where empty strings are found.
 
virtual void SetPedigreeIdArrayName (const char *)
 The name of the array for generating or assigning pedigree ids (default "id").
 
virtual char * GetPedigreeIdArrayName ()
 The name of the array for generating or assigning pedigree ids (default "id").
 
virtual void SetGeneratePedigreeIds (bool)
 If on (default), generates pedigree ids automatically.
 
virtual bool GetGeneratePedigreeIds ()
 If on (default), generates pedigree ids automatically.
 
virtual void GeneratePedigreeIdsOn ()
 If on (default), generates pedigree ids automatically.
 
virtual void GeneratePedigreeIdsOff ()
 If on (default), generates pedigree ids automatically.
 
virtual void SetOutputPedigreeIds (bool)
 If on, assigns pedigree ids to output.
 
virtual bool GetOutputPedigreeIds ()
 If on, assigns pedigree ids to output.
 
virtual void OutputPedigreeIdsOn ()
 If on, assigns pedigree ids to output.
 
virtual void OutputPedigreeIdsOff ()
 If on, assigns pedigree ids to output.
 
virtual void SetAddTabFieldDelimiter (bool)
 If on, also add in the tab (i.e.
 
virtual bool GetAddTabFieldDelimiter ()
 If on, also add in the tab (i.e.
 
virtual void AddTabFieldDelimiterOn ()
 If on, also add in the tab (i.e.
 
virtual void AddTabFieldDelimiterOff ()
 If on, also add in the tab (i.e.
 
virtual void SetReplacementCharacter (vtkTypeUInt32)
 Fallback character for use in the US-ASCII-WITH-FALLBACK character set.
 
virtual vtkTypeUInt32 GetReplacementCharacter ()
 Fallback character for use in the US-ASCII-WITH-FALLBACK character set.
 
- Public Member Functions inherited from vtkTableAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkTableAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details
 
vtkTableGetOutput ()
 Get the output data object for a port on this algorithm.
 
vtkTableGetOutput (int index)
 
void SetInputData (vtkDataObject *obj)
 Assign a data object as input.
 
void SetInputData (int index, vtkDataObject *obj)
 
- Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive.
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive.
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive.
 
virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped.
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request.
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port.
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port.
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm.
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm.
 
void SetProgress (double)
 SetProgress is deprecated.
 
void UpdateProgress (double amount)
 Update the progress of the process object.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess().
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
 
void RemoveAllInputs ()
 Remove all the input data.
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection.
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index.
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx.
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections.
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index.
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port.
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm.
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port.
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm.
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0).
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection.
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0)
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection.
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0)
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port.
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port.
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date.
 
virtual void UpdateDataObject ()
 Create output object(s).
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream.
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date.
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm.
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm.
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection.
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection.
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object.
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object.
 
virtual double GetProgress ()
 Get the execution progress of a process object.
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state.
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state.
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date.
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date.
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports.
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports.
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents.
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents.
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkDelimitedTextReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDelimitedTextReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkTableAlgorithm
static vtkTableAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTableAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements.
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDelimitedTextReader ()
 
 ~vtkDelimitedTextReader () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass.
 
int ReadData (vtkTable *const output_table)
 
- Protected Member Functions inherited from vtkTableAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkTableAlgorithm ()
 
 ~vtkTableAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 This is called by the superclass.
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass.
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm.
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm.
 
- Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm.
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm.
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm.
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm.
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive.
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port.
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port.
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input.
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file.
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

char * FileName
 
vtkTypeBool ReadFromInputString
 
char * InputString
 
int InputStringLength
 
char * UnicodeCharacterSet
 
vtkIdType MaxRecords
 
vtkUnicodeString UnicodeRecordDelimiters
 
vtkUnicodeString UnicodeFieldDelimiters
 
vtkUnicodeString UnicodeStringDelimiters
 
vtkUnicodeString UnicodeWhitespace
 
vtkUnicodeString UnicodeEscapeCharacter
 
bool DetectNumericColumns
 
bool ForceDouble
 
bool TrimWhitespacePriorToNumericConversion
 
int DefaultIntegerValue
 
double DefaultDoubleValue
 
char * FieldDelimiterCharacters
 
char StringDelimiter
 
bool UseStringDelimiter
 
bool HaveHeaders
 
bool UnicodeOutputArrays
 
bool MergeConsecutiveDelimiters
 
char * PedigreeIdArrayName
 
bool GeneratePedigreeIds
 
bool OutputPedigreeIds
 
bool AddTabFieldDelimiter
 
vtkStdString LastError
 
vtkTypeUInt32 ReplacementCharacter
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file.
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

reads in delimited ascii or unicode text files and outputs a vtkTable data structure.

vtkDelimitedTextReader is an interface for pulling in data from a flat, delimited ascii or unicode text file (delimiter can be any character).

The behavior of the reader with respect to ascii or unicode input is controlled by the SetUnicodeCharacterSet() method. By default (without calling SetUnicodeCharacterSet()), the reader will expect to read ascii text and will output vtkStdString columns. Use the Set and Get methods to set delimiters that do not contain UTF8 in the name when operating the reader in default ascii mode. If the SetUnicodeCharacterSet() method is called, the reader will output vtkUnicodeString columns in the output table. In addition, it is necessary to use the Set and Get methods that contain UTF8 in the name to specify delimiters when operating in unicode mode.

There is also a special character set US-ASCII-WITH-FALLBACK that will treat the input text as ASCII no matter what. If and when it encounters a character with its 8th bit set it will replace that character with the code point ReplacementCharacter. You may use this if you have text that belongs to a code page like LATIN9 or ISO-8859-1 or friends: mostly ASCII but not entirely. Eventually this class will acquire the ability to read gracefully text from any code page, making this option obsolete.

This class emits ProgressEvent for every 100 lines it reads.

Thanks:
Thanks to Andy Wilson, Brian Wylie, Tim Shead, and Thomas Otahal from Sandia National Laboratories for implementing this class.
Warning
This reader assumes that the first line in the file (whether that's headers or the first document) contains at least as many fields as any other line in the file.
Online Examples:

Definition at line 110 of file vtkDelimitedTextReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 114 of file vtkDelimitedTextReader.h.

Constructor & Destructor Documentation

◆ vtkDelimitedTextReader()

vtkDelimitedTextReader::vtkDelimitedTextReader ( )
protected

◆ ~vtkDelimitedTextReader()

vtkDelimitedTextReader::~vtkDelimitedTextReader ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkDelimitedTextReader * vtkDelimitedTextReader::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkDelimitedTextReader::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkDelimitedTextReader::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkTemporalDelimitedTextReader.

◆ SafeDownCast()

static vtkDelimitedTextReader * vtkDelimitedTextReader::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDelimitedTextReader::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkTemporalDelimitedTextReader.

◆ NewInstance()

vtkDelimitedTextReader * vtkDelimitedTextReader::NewInstance ( ) const

◆ PrintSelf()

void vtkDelimitedTextReader::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkTemporalDelimitedTextReader.

◆ vtkGetFilePathMacro()

vtkDelimitedTextReader::vtkGetFilePathMacro ( FileName  )

Specifies the delimited text file to be loaded.

◆ vtkSetFilePathMacro()

vtkDelimitedTextReader::vtkSetFilePathMacro ( FileName  )

Specifies the delimited text file to be loaded.

◆ SetInputString() [1/3]

void vtkDelimitedTextReader::SetInputString ( const char *  in)

Specify the InputString for use when reading from a character array.

Optionally include the length for binary strings. Note that a copy of the string is made and stored. If this causes exceedingly large memory consumption, consider using InputArray instead.

◆ GetInputString()

virtual char * vtkDelimitedTextReader::GetInputString ( )
virtual

Specify the InputString for use when reading from a character array.

Optionally include the length for binary strings. Note that a copy of the string is made and stored. If this causes exceedingly large memory consumption, consider using InputArray instead.

◆ SetInputString() [2/3]

void vtkDelimitedTextReader::SetInputString ( const char *  in,
int  len 
)

Specify the InputString for use when reading from a character array.

Optionally include the length for binary strings. Note that a copy of the string is made and stored. If this causes exceedingly large memory consumption, consider using InputArray instead.

◆ GetInputStringLength()

virtual int vtkDelimitedTextReader::GetInputStringLength ( )
virtual

Specify the InputString for use when reading from a character array.

Optionally include the length for binary strings. Note that a copy of the string is made and stored. If this causes exceedingly large memory consumption, consider using InputArray instead.

◆ SetInputString() [3/3]

void vtkDelimitedTextReader::SetInputString ( const vtkStdString input)
inline

Specify the InputString for use when reading from a character array.

Optionally include the length for binary strings. Note that a copy of the string is made and stored. If this causes exceedingly large memory consumption, consider using InputArray instead.

Definition at line 136 of file vtkDelimitedTextReader.h.

◆ SetReadFromInputString()

virtual void vtkDelimitedTextReader::SetReadFromInputString ( vtkTypeBool  )
virtual

Enable reading from an InputString or InputArray instead of the default, a file.

◆ GetReadFromInputString()

virtual vtkTypeBool vtkDelimitedTextReader::GetReadFromInputString ( )
virtual

Enable reading from an InputString or InputArray instead of the default, a file.

◆ ReadFromInputStringOn()

virtual void vtkDelimitedTextReader::ReadFromInputStringOn ( )
virtual

Enable reading from an InputString or InputArray instead of the default, a file.

◆ ReadFromInputStringOff()

virtual void vtkDelimitedTextReader::ReadFromInputStringOff ( )
virtual

Enable reading from an InputString or InputArray instead of the default, a file.

◆ GetUnicodeCharacterSet()

virtual char * vtkDelimitedTextReader::GetUnicodeCharacterSet ( )
virtual

Specifies the character set used in the input file.

Valid character set names will be drawn from the list maintained by the Internet Assigned Name Authority at

http://www.iana.org/assignments/character-sets

Where multiple aliases are provided for a character set, the preferred MIME name will be used. vtkUnicodeDelimitedTextReader currently supports "US-ASCII", "UTF-8", "UTF-16", "UTF-16BE", and "UTF-16LE" character sets.

◆ SetUnicodeCharacterSet()

virtual void vtkDelimitedTextReader::SetUnicodeCharacterSet ( const char *  )
virtual

Specifies the character set used in the input file.

Valid character set names will be drawn from the list maintained by the Internet Assigned Name Authority at

http://www.iana.org/assignments/character-sets

Where multiple aliases are provided for a character set, the preferred MIME name will be used. vtkUnicodeDelimitedTextReader currently supports "US-ASCII", "UTF-8", "UTF-16", "UTF-16BE", and "UTF-16LE" character sets.

◆ SetUTF8RecordDelimiters()

void vtkDelimitedTextReader::SetUTF8RecordDelimiters ( const char *  delimiters)

Specify the character(s) that will be used to separate records.

The order of characters in the string does not matter. Defaults to "\r\n".

◆ GetUTF8RecordDelimiters()

const char * vtkDelimitedTextReader::GetUTF8RecordDelimiters ( )

Specify the character(s) that will be used to separate records.

The order of characters in the string does not matter. Defaults to "\r\n".

◆ SetUnicodeRecordDelimiters()

void vtkDelimitedTextReader::SetUnicodeRecordDelimiters ( const vtkUnicodeString delimiters)

Specify the character(s) that will be used to separate records.

The order of characters in the string does not matter. Defaults to "\r\n".

◆ GetUnicodeRecordDelimiters()

vtkUnicodeString vtkDelimitedTextReader::GetUnicodeRecordDelimiters ( )

Specify the character(s) that will be used to separate records.

The order of characters in the string does not matter. Defaults to "\r\n".

◆ SetFieldDelimiterCharacters()

virtual void vtkDelimitedTextReader::SetFieldDelimiterCharacters ( const char *  )
virtual

Specify the character(s) that will be used to separate fields.

For example, set this to "," for a comma-separated value file. Set it to ".:;" for a file where columns can be separated by a period, colon or semicolon. The order of the characters in the string does not matter. Defaults to a comma.

◆ GetFieldDelimiterCharacters()

virtual char * vtkDelimitedTextReader::GetFieldDelimiterCharacters ( )
virtual

Specify the character(s) that will be used to separate fields.

For example, set this to "," for a comma-separated value file. Set it to ".:;" for a file where columns can be separated by a period, colon or semicolon. The order of the characters in the string does not matter. Defaults to a comma.

◆ SetUTF8FieldDelimiters()

void vtkDelimitedTextReader::SetUTF8FieldDelimiters ( const char *  delimiters)

◆ GetUTF8FieldDelimiters()

const char * vtkDelimitedTextReader::GetUTF8FieldDelimiters ( )

◆ SetUnicodeFieldDelimiters()

void vtkDelimitedTextReader::SetUnicodeFieldDelimiters ( const vtkUnicodeString delimiters)

◆ GetUnicodeFieldDelimiters()

vtkUnicodeString vtkDelimitedTextReader::GetUnicodeFieldDelimiters ( )

◆ GetStringDelimiter()

virtual char vtkDelimitedTextReader::GetStringDelimiter ( )
virtual

Get/set the character that will begin and end strings.

Microsoft Excel, for example, will export the following format:

"First Field","Second Field","Field, With, Commas","Fourth Field"

The third field has a comma in it. By using a string delimiter, this will be correctly read. The delimiter defaults to '"'.

◆ SetStringDelimiter()

virtual void vtkDelimitedTextReader::SetStringDelimiter ( char  )
virtual

Get/set the character that will begin and end strings.

Microsoft Excel, for example, will export the following format:

"First Field","Second Field","Field, With, Commas","Fourth Field"

The third field has a comma in it. By using a string delimiter, this will be correctly read. The delimiter defaults to '"'.

◆ SetUTF8StringDelimiters()

void vtkDelimitedTextReader::SetUTF8StringDelimiters ( const char *  delimiters)

◆ GetUTF8StringDelimiters()

const char * vtkDelimitedTextReader::GetUTF8StringDelimiters ( )

◆ SetUnicodeStringDelimiters()

void vtkDelimitedTextReader::SetUnicodeStringDelimiters ( const vtkUnicodeString delimiters)

◆ GetUnicodeStringDelimiters()

vtkUnicodeString vtkDelimitedTextReader::GetUnicodeStringDelimiters ( )

◆ SetUseStringDelimiter()

virtual void vtkDelimitedTextReader::SetUseStringDelimiter ( bool  )
virtual

Set/get whether to use the string delimiter.

Defaults to on.

◆ GetUseStringDelimiter()

virtual bool vtkDelimitedTextReader::GetUseStringDelimiter ( )
virtual

Set/get whether to use the string delimiter.

Defaults to on.

◆ UseStringDelimiterOn()

virtual void vtkDelimitedTextReader::UseStringDelimiterOn ( )
virtual

Set/get whether to use the string delimiter.

Defaults to on.

◆ UseStringDelimiterOff()

virtual void vtkDelimitedTextReader::UseStringDelimiterOff ( )
virtual

Set/get whether to use the string delimiter.

Defaults to on.

◆ GetHaveHeaders()

virtual bool vtkDelimitedTextReader::GetHaveHeaders ( )
virtual

Set/get whether to treat the first line of the file as headers.

The default is false (no headers).

◆ SetHaveHeaders()

virtual void vtkDelimitedTextReader::SetHaveHeaders ( bool  )
virtual

Set/get whether to treat the first line of the file as headers.

The default is false (no headers).

◆ SetMergeConsecutiveDelimiters()

virtual void vtkDelimitedTextReader::SetMergeConsecutiveDelimiters ( bool  )
virtual

Set/get whether to merge successive delimiters.

Use this if (for example) your fields are separated by spaces but you don't know exactly how many.

◆ GetMergeConsecutiveDelimiters()

virtual bool vtkDelimitedTextReader::GetMergeConsecutiveDelimiters ( )
virtual

Set/get whether to merge successive delimiters.

Use this if (for example) your fields are separated by spaces but you don't know exactly how many.

◆ MergeConsecutiveDelimitersOn()

virtual void vtkDelimitedTextReader::MergeConsecutiveDelimitersOn ( )
virtual

Set/get whether to merge successive delimiters.

Use this if (for example) your fields are separated by spaces but you don't know exactly how many.

◆ MergeConsecutiveDelimitersOff()

virtual void vtkDelimitedTextReader::MergeConsecutiveDelimitersOff ( )
virtual

Set/get whether to merge successive delimiters.

Use this if (for example) your fields are separated by spaces but you don't know exactly how many.

◆ GetMaxRecords()

virtual vtkIdType vtkDelimitedTextReader::GetMaxRecords ( )
virtual

Specifies the maximum number of records to read from the file.

Limiting the number of records to read is useful for previewing the contents of a file.

◆ SetMaxRecords()

virtual void vtkDelimitedTextReader::SetMaxRecords ( vtkIdType  )
virtual

Specifies the maximum number of records to read from the file.

Limiting the number of records to read is useful for previewing the contents of a file.

◆ SetDetectNumericColumns()

virtual void vtkDelimitedTextReader::SetDetectNumericColumns ( bool  )
virtual

When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray.

Default is off.

◆ GetDetectNumericColumns()

virtual bool vtkDelimitedTextReader::GetDetectNumericColumns ( )
virtual

When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray.

Default is off.

◆ DetectNumericColumnsOn()

virtual void vtkDelimitedTextReader::DetectNumericColumnsOn ( )
virtual

When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray.

Default is off.

◆ DetectNumericColumnsOff()

virtual void vtkDelimitedTextReader::DetectNumericColumnsOff ( )
virtual

When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray.

Default is off.

◆ SetForceDouble()

virtual void vtkDelimitedTextReader::SetForceDouble ( bool  )
virtual

When set to true and DetectNumericColumns is also true, forces all numeric columns to vtkDoubleArray even if they contain only integer values.

Default is off.

◆ GetForceDouble()

virtual bool vtkDelimitedTextReader::GetForceDouble ( )
virtual

When set to true and DetectNumericColumns is also true, forces all numeric columns to vtkDoubleArray even if they contain only integer values.

Default is off.

◆ ForceDoubleOn()

virtual void vtkDelimitedTextReader::ForceDoubleOn ( )
virtual

When set to true and DetectNumericColumns is also true, forces all numeric columns to vtkDoubleArray even if they contain only integer values.

Default is off.

◆ ForceDoubleOff()

virtual void vtkDelimitedTextReader::ForceDoubleOff ( )
virtual

When set to true and DetectNumericColumns is also true, forces all numeric columns to vtkDoubleArray even if they contain only integer values.

Default is off.

◆ SetTrimWhitespacePriorToNumericConversion()

virtual void vtkDelimitedTextReader::SetTrimWhitespacePriorToNumericConversion ( bool  )
virtual

When DetectNumericColumns is set to true, whether to trim whitespace from strings prior to conversion to a numeric.

Default is false to preserve backward compatibility.

vtkVariant handles whitespace inconsistently, so trim it before we try to convert it. For example:

vtkVariant(" 2.0").ToDouble() == 2.0 <– leading whitespace is not a problem vtkVariant(" 2.0 ").ToDouble() == NaN <– trailing whitespace is a problem vtkVariant(" infinity ").ToDouble() == NaN <– any whitespace is a problem

In these cases, trimming the whitespace gives us the result we expect: 2.0 and INF respectively.

◆ GetTrimWhitespacePriorToNumericConversion()

virtual bool vtkDelimitedTextReader::GetTrimWhitespacePriorToNumericConversion ( )
virtual

When DetectNumericColumns is set to true, whether to trim whitespace from strings prior to conversion to a numeric.

Default is false to preserve backward compatibility.

vtkVariant handles whitespace inconsistently, so trim it before we try to convert it. For example:

vtkVariant(" 2.0").ToDouble() == 2.0 <– leading whitespace is not a problem vtkVariant(" 2.0 ").ToDouble() == NaN <– trailing whitespace is a problem vtkVariant(" infinity ").ToDouble() == NaN <– any whitespace is a problem

In these cases, trimming the whitespace gives us the result we expect: 2.0 and INF respectively.

◆ TrimWhitespacePriorToNumericConversionOn()

virtual void vtkDelimitedTextReader::TrimWhitespacePriorToNumericConversionOn ( )
virtual

When DetectNumericColumns is set to true, whether to trim whitespace from strings prior to conversion to a numeric.

Default is false to preserve backward compatibility.

vtkVariant handles whitespace inconsistently, so trim it before we try to convert it. For example:

vtkVariant(" 2.0").ToDouble() == 2.0 <– leading whitespace is not a problem vtkVariant(" 2.0 ").ToDouble() == NaN <– trailing whitespace is a problem vtkVariant(" infinity ").ToDouble() == NaN <– any whitespace is a problem

In these cases, trimming the whitespace gives us the result we expect: 2.0 and INF respectively.

◆ TrimWhitespacePriorToNumericConversionOff()

virtual void vtkDelimitedTextReader::TrimWhitespacePriorToNumericConversionOff ( )
virtual

When DetectNumericColumns is set to true, whether to trim whitespace from strings prior to conversion to a numeric.

Default is false to preserve backward compatibility.

vtkVariant handles whitespace inconsistently, so trim it before we try to convert it. For example:

vtkVariant(" 2.0").ToDouble() == 2.0 <– leading whitespace is not a problem vtkVariant(" 2.0 ").ToDouble() == NaN <– trailing whitespace is a problem vtkVariant(" infinity ").ToDouble() == NaN <– any whitespace is a problem

In these cases, trimming the whitespace gives us the result we expect: 2.0 and INF respectively.

◆ SetDefaultIntegerValue()

virtual void vtkDelimitedTextReader::SetDefaultIntegerValue ( int  )
virtual

When DetectNumericColumns is set to true, the reader use this value to populate the vtkIntArray where empty strings are found.

Default is 0.

◆ GetDefaultIntegerValue()

virtual int vtkDelimitedTextReader::GetDefaultIntegerValue ( )
virtual

When DetectNumericColumns is set to true, the reader use this value to populate the vtkIntArray where empty strings are found.

Default is 0.

◆ SetDefaultDoubleValue()

virtual void vtkDelimitedTextReader::SetDefaultDoubleValue ( double  )
virtual

When DetectNumericColumns is set to true, the reader use this value to populate the vtkDoubleArray where empty strings are found.

Default is 0.0

◆ GetDefaultDoubleValue()

virtual double vtkDelimitedTextReader::GetDefaultDoubleValue ( )
virtual

When DetectNumericColumns is set to true, the reader use this value to populate the vtkDoubleArray where empty strings are found.

Default is 0.0

◆ SetPedigreeIdArrayName()

virtual void vtkDelimitedTextReader::SetPedigreeIdArrayName ( const char *  )
virtual

The name of the array for generating or assigning pedigree ids (default "id").

◆ GetPedigreeIdArrayName()

virtual char * vtkDelimitedTextReader::GetPedigreeIdArrayName ( )
virtual

The name of the array for generating or assigning pedigree ids (default "id").

◆ SetGeneratePedigreeIds()

virtual void vtkDelimitedTextReader::SetGeneratePedigreeIds ( bool  )
virtual

If on (default), generates pedigree ids automatically.

If off, assign one of the arrays to be the pedigree id.

◆ GetGeneratePedigreeIds()

virtual bool vtkDelimitedTextReader::GetGeneratePedigreeIds ( )
virtual

If on (default), generates pedigree ids automatically.

If off, assign one of the arrays to be the pedigree id.

◆ GeneratePedigreeIdsOn()

virtual void vtkDelimitedTextReader::GeneratePedigreeIdsOn ( )
virtual

If on (default), generates pedigree ids automatically.

If off, assign one of the arrays to be the pedigree id.

◆ GeneratePedigreeIdsOff()

virtual void vtkDelimitedTextReader::GeneratePedigreeIdsOff ( )
virtual

If on (default), generates pedigree ids automatically.

If off, assign one of the arrays to be the pedigree id.

◆ SetOutputPedigreeIds()

virtual void vtkDelimitedTextReader::SetOutputPedigreeIds ( bool  )
virtual

If on, assigns pedigree ids to output.

Defaults to off.

◆ GetOutputPedigreeIds()

virtual bool vtkDelimitedTextReader::GetOutputPedigreeIds ( )
virtual

If on, assigns pedigree ids to output.

Defaults to off.

◆ OutputPedigreeIdsOn()

virtual void vtkDelimitedTextReader::OutputPedigreeIdsOn ( )
virtual

If on, assigns pedigree ids to output.

Defaults to off.

◆ OutputPedigreeIdsOff()

virtual void vtkDelimitedTextReader::OutputPedigreeIdsOff ( )
virtual

If on, assigns pedigree ids to output.

Defaults to off.

◆ SetAddTabFieldDelimiter()

virtual void vtkDelimitedTextReader::SetAddTabFieldDelimiter ( bool  )
virtual

If on, also add in the tab (i.e.

'\t') character as a field delimiter. We add this specially since applications may have a more difficult time doing this. Defaults to off.

◆ GetAddTabFieldDelimiter()

virtual bool vtkDelimitedTextReader::GetAddTabFieldDelimiter ( )
virtual

If on, also add in the tab (i.e.

'\t') character as a field delimiter. We add this specially since applications may have a more difficult time doing this. Defaults to off.

◆ AddTabFieldDelimiterOn()

virtual void vtkDelimitedTextReader::AddTabFieldDelimiterOn ( )
virtual

If on, also add in the tab (i.e.

'\t') character as a field delimiter. We add this specially since applications may have a more difficult time doing this. Defaults to off.

◆ AddTabFieldDelimiterOff()

virtual void vtkDelimitedTextReader::AddTabFieldDelimiterOff ( )
virtual

If on, also add in the tab (i.e.

'\t') character as a field delimiter. We add this specially since applications may have a more difficult time doing this. Defaults to off.

◆ GetLastError()

vtkStdString vtkDelimitedTextReader::GetLastError ( )

Returns a human-readable description of the most recent error, if any.

Otherwise, returns an empty string. Note that the result is only valid after calling Update().

◆ SetReplacementCharacter()

virtual void vtkDelimitedTextReader::SetReplacementCharacter ( vtkTypeUInt32  )
virtual

Fallback character for use in the US-ASCII-WITH-FALLBACK character set.

Any characters that have their 8th bit set will be replaced with this code point. Defaults to 'x'.

◆ GetReplacementCharacter()

virtual vtkTypeUInt32 vtkDelimitedTextReader::GetReplacementCharacter ( )
virtual

Fallback character for use in the US-ASCII-WITH-FALLBACK character set.

Any characters that have their 8th bit set will be replaced with this code point. Defaults to 'x'.

◆ RequestData()

int vtkDelimitedTextReader::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkTableAlgorithm.

Reimplemented in vtkTemporalDelimitedTextReader.

◆ ReadData()

int vtkDelimitedTextReader::ReadData ( vtkTable *const  output_table)
protected

Member Data Documentation

◆ FileName

char* vtkDelimitedTextReader::FileName
protected

Definition at line 386 of file vtkDelimitedTextReader.h.

◆ ReadFromInputString

vtkTypeBool vtkDelimitedTextReader::ReadFromInputString
protected

Definition at line 387 of file vtkDelimitedTextReader.h.

◆ InputString

char* vtkDelimitedTextReader::InputString
protected

Definition at line 388 of file vtkDelimitedTextReader.h.

◆ InputStringLength

int vtkDelimitedTextReader::InputStringLength
protected

Definition at line 389 of file vtkDelimitedTextReader.h.

◆ UnicodeCharacterSet

char* vtkDelimitedTextReader::UnicodeCharacterSet
protected

Definition at line 390 of file vtkDelimitedTextReader.h.

◆ MaxRecords

vtkIdType vtkDelimitedTextReader::MaxRecords
protected

Definition at line 391 of file vtkDelimitedTextReader.h.

◆ UnicodeRecordDelimiters

vtkUnicodeString vtkDelimitedTextReader::UnicodeRecordDelimiters
protected

Definition at line 392 of file vtkDelimitedTextReader.h.

◆ UnicodeFieldDelimiters

vtkUnicodeString vtkDelimitedTextReader::UnicodeFieldDelimiters
protected

Definition at line 393 of file vtkDelimitedTextReader.h.

◆ UnicodeStringDelimiters

vtkUnicodeString vtkDelimitedTextReader::UnicodeStringDelimiters
protected

Definition at line 394 of file vtkDelimitedTextReader.h.

◆ UnicodeWhitespace

vtkUnicodeString vtkDelimitedTextReader::UnicodeWhitespace
protected

Definition at line 395 of file vtkDelimitedTextReader.h.

◆ UnicodeEscapeCharacter

vtkUnicodeString vtkDelimitedTextReader::UnicodeEscapeCharacter
protected

Definition at line 396 of file vtkDelimitedTextReader.h.

◆ DetectNumericColumns

bool vtkDelimitedTextReader::DetectNumericColumns
protected

Definition at line 397 of file vtkDelimitedTextReader.h.

◆ ForceDouble

bool vtkDelimitedTextReader::ForceDouble
protected

Definition at line 398 of file vtkDelimitedTextReader.h.

◆ TrimWhitespacePriorToNumericConversion

bool vtkDelimitedTextReader::TrimWhitespacePriorToNumericConversion
protected

Definition at line 399 of file vtkDelimitedTextReader.h.

◆ DefaultIntegerValue

int vtkDelimitedTextReader::DefaultIntegerValue
protected

Definition at line 400 of file vtkDelimitedTextReader.h.

◆ DefaultDoubleValue

double vtkDelimitedTextReader::DefaultDoubleValue
protected

Definition at line 401 of file vtkDelimitedTextReader.h.

◆ FieldDelimiterCharacters

char* vtkDelimitedTextReader::FieldDelimiterCharacters
protected

Definition at line 402 of file vtkDelimitedTextReader.h.

◆ StringDelimiter

char vtkDelimitedTextReader::StringDelimiter
protected

Definition at line 403 of file vtkDelimitedTextReader.h.

◆ UseStringDelimiter

bool vtkDelimitedTextReader::UseStringDelimiter
protected

Definition at line 404 of file vtkDelimitedTextReader.h.

◆ HaveHeaders

bool vtkDelimitedTextReader::HaveHeaders
protected

Definition at line 405 of file vtkDelimitedTextReader.h.

◆ UnicodeOutputArrays

bool vtkDelimitedTextReader::UnicodeOutputArrays
protected

Definition at line 406 of file vtkDelimitedTextReader.h.

◆ MergeConsecutiveDelimiters

bool vtkDelimitedTextReader::MergeConsecutiveDelimiters
protected

Definition at line 407 of file vtkDelimitedTextReader.h.

◆ PedigreeIdArrayName

char* vtkDelimitedTextReader::PedigreeIdArrayName
protected

Definition at line 408 of file vtkDelimitedTextReader.h.

◆ GeneratePedigreeIds

bool vtkDelimitedTextReader::GeneratePedigreeIds
protected

Definition at line 409 of file vtkDelimitedTextReader.h.

◆ OutputPedigreeIds

bool vtkDelimitedTextReader::OutputPedigreeIds
protected

Definition at line 410 of file vtkDelimitedTextReader.h.

◆ AddTabFieldDelimiter

bool vtkDelimitedTextReader::AddTabFieldDelimiter
protected

Definition at line 411 of file vtkDelimitedTextReader.h.

◆ LastError

vtkStdString vtkDelimitedTextReader::LastError
protected

Definition at line 412 of file vtkDelimitedTextReader.h.

◆ ReplacementCharacter

vtkTypeUInt32 vtkDelimitedTextReader::ReplacementCharacter
protected

Definition at line 413 of file vtkDelimitedTextReader.h.


The documentation for this class was generated from the following file: