vtkTemporalDelimitedTextReader Class Reference

reads a delimited ascii or unicode text files and and output a temporal vtkTable. More...

#include <vtkTemporalDelimitedTextReader.h>

Inheritance diagram for vtkTemporalDelimitedTextReader:

Collaboration diagram for vtkTemporalDelimitedTextReader:

Public Types
typedef vtkDelimitedTextReader	Superclass
Public Types inherited from vtkDelimitedTextReader
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.
vtkTemporalDelimitedTextReader *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkMTimeType	GetMTime () override
	Internal fields of this reader use a specific MTime (InternalMTime).
virtual std::string	GetTimeColumnName ()
	Get/Set the name of the column to use as time indicator.
void	SetTimeColumnName (const std::string name)
	Get/Set the name of the column to use as time indicator.
virtual int	GetTimeColumnId ()
	Get/Set the column to use as time indicator.
void	SetTimeColumnId (const int idx)
	Get/Set the column to use as time indicator.
virtual bool	GetRemoveTimeStepColumn ()
	Set the RemoveTimeStepColumn flag If this boolean is true, the output will not contain the Time step column.
void	SetRemoveTimeStepColumn (bool rts)
	Set the RemoveTimeStepColumn flag If this boolean is true, the output will not contain the Time step column.
Public Member Functions inherited from vtkDelimitedTextReader
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkDelimitedTextReader *	NewInstance () 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.
vtkTableAlgorithm *	NewInstance () 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
vtkTable *	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkTable *	GetOutput (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.
vtkAlgorithm *	NewInstance () 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.
vtkExecutive *	GetExecutive ()
	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.
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.
vtkInformation *	GetOutputPortInformation (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().
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
void	RemoveAllInputs ()
	Remove all the input data.
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkDataObject *	GetInputDataObject (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)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutput *	GetOutputPort ()
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.
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)
vtkInformation *	GetOutputInformation (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 vtkInformation *	GetInformation ()
	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 vtkProgressObserver *	GetProgressObserver ()
	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.
vtkCommand *	GetCommand (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 vtkTemporalDelimitedTextReader *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkTemporalDelimitedTextReader *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkDelimitedTextReader
static vtkDelimitedTextReader *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkDelimitedTextReader *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkTableAlgorithm
static vtkTableAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkTableAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_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 vtkInformationIntegerKey *	CAN_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 vtkObject *	New ()
	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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () const
	vtkTemporalDelimitedTextReader ()
	~vtkTemporalDelimitedTextReader () override=default
int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
	In order to fill the TIME_STEPS and TIME_RANGE keys, this method call the ReadData function that actually read the full input file content (may be slow!).
int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
	This is called by the superclass.
bool	EnforceColumnName ()
	This function checks if a user specified column has been set and check if this input is valid.
void	InternalModified ()
	When parameters specific of this reader are modified, we do not want to re-read the input file.
Protected Member Functions inherited from vtkDelimitedTextReader
virtual vtkObjectBase *	NewInstanceInternal () 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 vtkObjectBase *	NewInstanceInternal () 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 vtkObjectBase *	NewInstanceInternal () 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.
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
virtual vtkExecutive *	CreateDefaultExecutive ()
	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.
vtkDataArray *	GetInputArrayToProcess (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.
vtkDataArray *	GetInputArrayToProcess (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.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (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.
vtkAbstractArray *	GetInputAbstractArrayToProcess (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.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (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
std::string	TimeColumnName = ""
std::string	InternalColumnName = ""
vtkIdType	TimeColumnId = -1
bool	RemoveTimeStepColumn = true
std::map< double, std::vector< vtkIdType > >	TimeMap
vtkNew< vtkTable >	ReadTable
vtkMTimeType	LastReadTime = 0
vtkTimeStamp	InternalMTime
Protected Attributes inherited from vtkDelimitedTextReader
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
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
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 vtkInformationIntegerKey *	PORT_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 vtkExecutive *	DefaultExecutivePrototype

Detailed Description

reads a delimited ascii or unicode text files and and output a temporal vtkTable.

This reader requires that FieldDelimiterCharacters is set before the pipeline is executed, otherwise it will produce an empty output.

A column can be selected as time step indicator using the SetTimeColumnName or SetTimeColumnId functions. If so, for a given time step 's' only the lines where the time step indicator column have the value 's' are present. To control if the time step indicator column should be present in the output, a RemoveTimeStepColumn option is available. If no time step indicator column is given by the user, the whole file it outputted.

This reader assume the time step column is numeric. A warning is set otherwise. The DetectNumericColumns field is set to on, do not change this field unless you really know what you are doing.

See also

vtkDelimitedTextReader

Definition at line 49 of file vtkTemporalDelimitedTextReader.h.

Member Typedef Documentation

Superclass

typedef vtkDelimitedTextReader vtkTemporalDelimitedTextReader::Superclass

Definition at line 53 of file vtkTemporalDelimitedTextReader.h.

Constructor & Destructor Documentation

vtkTemporalDelimitedTextReader()

vtkTemporalDelimitedTextReader::vtkTemporalDelimitedTextReader ( )

protected

~vtkTemporalDelimitedTextReader()

vtkTemporalDelimitedTextReader::~vtkTemporalDelimitedTextReader ( )

overrideprotecteddefault

Member Function Documentation

New()

static vtkTemporalDelimitedTextReader * vtkTemporalDelimitedTextReader::New ( )

static

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkTemporalDelimitedTextReader::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 vtkDelimitedTextReader.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkTemporalDelimitedTextReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDelimitedTextReader.

NewInstance()

vtkTemporalDelimitedTextReader * vtkTemporalDelimitedTextReader::NewInstance

(

)

const

PrintSelf()

void vtkTemporalDelimitedTextReader::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 vtkDelimitedTextReader.

GetTimeColumnName()

virtual std::string vtkTemporalDelimitedTextReader::GetTimeColumnName ( )

virtual

Get/Set the name of the column to use as time indicator.

Ignored if TimeColumnId is not equal to -1. If no column has been chosen using either the TimeColumnId or the TimeColumnName the whole input file is outputted. Default to empty string.

SetTimeColumnName()

void vtkTemporalDelimitedTextReader::SetTimeColumnName

(

const std::string

name

)

Get/Set the name of the column to use as time indicator.

Ignored if TimeColumnId is not equal to -1. If no column has been chosen using either the TimeColumnId or the TimeColumnName the whole input file is outputted. Default to empty string.

GetTimeColumnId()

virtual int vtkTemporalDelimitedTextReader::GetTimeColumnId ( )

virtual

Get/Set the column to use as time indicator.

It the TimeColumnId is equal to -1, the TimeColumnName will be used instead. If no column has been chosen using either the TimeColumnId or the TimeColumnName the whole input file is outputted. Default to -1.

SetTimeColumnId()

void vtkTemporalDelimitedTextReader::SetTimeColumnId

(

const int

idx

)

Get/Set the column to use as time indicator.

It the TimeColumnId is equal to -1, the TimeColumnName will be used instead. If no column has been chosen using either the TimeColumnId or the TimeColumnName the whole input file is outputted. Default to -1.

GetRemoveTimeStepColumn()

virtual bool vtkTemporalDelimitedTextReader::GetRemoveTimeStepColumn ( )

virtual

Set the RemoveTimeStepColumn flag If this boolean is true, the output will not contain the Time step column.

Default to true.

SetRemoveTimeStepColumn()

void vtkTemporalDelimitedTextReader::SetRemoveTimeStepColumn

(

bool

rts

)

Set the RemoveTimeStepColumn flag If this boolean is true, the output will not contain the Time step column.

Default to true.

GetMTime()

vtkMTimeType vtkTemporalDelimitedTextReader::GetMTime ( )

overridevirtual

Internal fields of this reader use a specific MTime (InternalMTime).

This mechamism ensure the actual data is only re-read when necessary. Here, we ensure the GetMTime of this reader stay consistent by returning the latest between the MTime of this reader and the internal one.

See also

InternalModified

Reimplemented from vtkObject.

RequestInformation()

int vtkTemporalDelimitedTextReader::RequestInformation ( vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector  )

overrideprotectedvirtual

In order to fill the TIME_STEPS and TIME_RANGE keys, this method call the ReadData function that actually read the full input file content (may be slow!).

Custom MTime management is used to ensure we do not re-read the input file uselessly.

Reimplemented from vtkTableAlgorithm.

RequestData()

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

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkDelimitedTextReader.

EnforceColumnName()

bool vtkTemporalDelimitedTextReader::EnforceColumnName ( )

protected

This function checks if a user specified column has been set and check if this input is valid.

If an invalid input has been detected, return false. Otherwise, InternalColumnName will be set to the name of the time column or empty if none has been given by the user.

InternalModified()

void vtkTemporalDelimitedTextReader::InternalModified ( )

protected

When parameters specific of this reader are modified, we do not want to re-read the input file.

Keep an internal time stamp to track them.

Member Data Documentation

TimeColumnName

std::string vtkTemporalDelimitedTextReader::TimeColumnName = ""

protected

Definition at line 130 of file vtkTemporalDelimitedTextReader.h.

InternalColumnName

std::string vtkTemporalDelimitedTextReader::InternalColumnName = ""

protected

Definition at line 131 of file vtkTemporalDelimitedTextReader.h.

TimeColumnId

vtkIdType vtkTemporalDelimitedTextReader::TimeColumnId = -1

protected

Definition at line 132 of file vtkTemporalDelimitedTextReader.h.

RemoveTimeStepColumn

bool vtkTemporalDelimitedTextReader::RemoveTimeStepColumn = true

protected

Definition at line 133 of file vtkTemporalDelimitedTextReader.h.

TimeMap

std::map<double, std::vector<vtkIdType> > vtkTemporalDelimitedTextReader::TimeMap

protected

Definition at line 134 of file vtkTemporalDelimitedTextReader.h.

ReadTable

vtkNew<vtkTable> vtkTemporalDelimitedTextReader::ReadTable

protected

Definition at line 137 of file vtkTemporalDelimitedTextReader.h.

LastReadTime

vtkMTimeType vtkTemporalDelimitedTextReader::LastReadTime = 0

protected

Definition at line 138 of file vtkTemporalDelimitedTextReader.h.

InternalMTime

vtkTimeStamp vtkTemporalDelimitedTextReader::InternalMTime

protected

Definition at line 139 of file vtkTemporalDelimitedTextReader.h.

---

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

• IO/Infovis/vtkTemporalDelimitedTextReader.h