VTK  9.3.20240328
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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:
[legend]
Collaboration diagram for vtkTemporalDelimitedTextReader:
[legend]

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. More...
 
vtkTemporalDelimitedTextReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkMTimeType GetMTime () override
 Internal fields of this reader use a specific MTime (InternalMTime). More...
 
virtual std::string GetTimeColumnName ()
 Get/Set the name of the column to use as time indicator. More...
 
void SetTimeColumnName (std::string name)
 Get/Set the name of the column to use as time indicator. More...
 
virtual int GetTimeColumnId ()
 Get/Set the column to use as time indicator. More...
 
void SetTimeColumnId (int idx)
 Get/Set the column to use as time indicator. More...
 
virtual bool GetRemoveTimeStepColumn ()
 Set the RemoveTimeStepColumn flag If this boolean is true, the output will not contain the Time step column. More...
 
void SetRemoveTimeStepColumn (bool rts)
 Set the RemoveTimeStepColumn flag If this boolean is true, the output will not contain the Time step column. More...
 
- Public Member Functions inherited from vtkDelimitedTextReader
vtkDelimitedTextReaderNewInstance () const
 
void SetUTF8FieldDelimiters (const char *delimiters)
 
const char * GetUTF8FieldDelimiters ()
 
void SetUTF8StringDelimiters (const char *delimiters)
 
const char * GetUTF8StringDelimiters ()
 
vtkStdString GetLastError ()
 Returns a human-readable description of the most recent error, if any. More...
 
 vtkGetFilePathMacro (FileName)
 Specifies the delimited text file to be loaded. More...
 
 vtkSetFilePathMacro (FileName)
 Specifies the delimited text file to be loaded. More...
 
void SetInputString (const char *in)
 Specify the InputString for use when reading from a character array. More...
 
virtual char * GetInputString ()
 Specify the InputString for use when reading from a character array. More...
 
void SetInputString (const char *in, int len)
 Specify the InputString for use when reading from a character array. More...
 
virtual int GetInputStringLength ()
 Specify the InputString for use when reading from a character array. More...
 
void SetInputString (const vtkStdString &input)
 Specify the InputString for use when reading from a character array. More...
 
virtual void SetReadFromInputString (vtkTypeBool)
 Enable reading from an InputString or InputArray instead of the default, a file. More...
 
virtual vtkTypeBool GetReadFromInputString ()
 Enable reading from an InputString or InputArray instead of the default, a file. More...
 
virtual void ReadFromInputStringOn ()
 Enable reading from an InputString or InputArray instead of the default, a file. More...
 
virtual void ReadFromInputStringOff ()
 Enable reading from an InputString or InputArray instead of the default, a file. More...
 
virtual char * GetUnicodeCharacterSet ()
 Specifies the character set used in the input file. More...
 
virtual void SetUnicodeCharacterSet (const char *)
 Specifies the character set used in the input file. More...
 
void SetUTF8RecordDelimiters (const char *delimiters)
 Specify the character(s) that will be used to separate records. More...
 
const char * GetUTF8RecordDelimiters ()
 Specify the character(s) that will be used to separate records. More...
 
virtual void SetFieldDelimiterCharacters (const char *)
 Specify the character(s) that will be used to separate fields. More...
 
virtual char * GetFieldDelimiterCharacters ()
 Specify the character(s) that will be used to separate fields. More...
 
virtual char GetStringDelimiter ()
 Get/set the character that will begin and end strings. More...
 
virtual void SetStringDelimiter (char)
 Get/set the character that will begin and end strings. More...
 
virtual void SetUseStringDelimiter (bool)
 Set/get whether to use the string delimiter. More...
 
virtual bool GetUseStringDelimiter ()
 Set/get whether to use the string delimiter. More...
 
virtual void UseStringDelimiterOn ()
 Set/get whether to use the string delimiter. More...
 
virtual void UseStringDelimiterOff ()
 Set/get whether to use the string delimiter. More...
 
virtual bool GetHaveHeaders ()
 Set/get whether to treat the first line of the file as headers. More...
 
virtual void SetHaveHeaders (bool)
 Set/get whether to treat the first line of the file as headers. More...
 
virtual void SetMergeConsecutiveDelimiters (bool)
 Set/get whether to merge successive delimiters. More...
 
virtual bool GetMergeConsecutiveDelimiters ()
 Set/get whether to merge successive delimiters. More...
 
virtual void MergeConsecutiveDelimitersOn ()
 Set/get whether to merge successive delimiters. More...
 
virtual void MergeConsecutiveDelimitersOff ()
 Set/get whether to merge successive delimiters. More...
 
virtual vtkIdType GetMaxRecords ()
 Specifies the maximum number of records to read from the file. More...
 
virtual void SetMaxRecords (vtkIdType)
 Specifies the maximum number of records to read from the file. More...
 
virtual void SetDetectNumericColumns (bool)
 When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray. More...
 
virtual bool GetDetectNumericColumns ()
 When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray. More...
 
virtual void DetectNumericColumnsOn ()
 When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray. More...
 
virtual void DetectNumericColumnsOff ()
 When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void SetTrimWhitespacePriorToNumericConversion (bool)
 When DetectNumericColumns is set to true, whether to trim whitespace from strings prior to conversion to a numeric. More...
 
virtual bool GetTrimWhitespacePriorToNumericConversion ()
 When DetectNumericColumns is set to true, whether to trim whitespace from strings prior to conversion to a numeric. More...
 
virtual void TrimWhitespacePriorToNumericConversionOn ()
 When DetectNumericColumns is set to true, whether to trim whitespace from strings prior to conversion to a numeric. More...
 
virtual void TrimWhitespacePriorToNumericConversionOff ()
 When DetectNumericColumns is set to true, whether to trim whitespace from strings prior to conversion to a numeric. More...
 
virtual void SetDefaultIntegerValue (int)
 When DetectNumericColumns is set to true, the reader use this value to populate the vtkIntArray where empty strings are found. More...
 
virtual int GetDefaultIntegerValue ()
 When DetectNumericColumns is set to true, the reader use this value to populate the vtkIntArray where empty strings are found. More...
 
virtual void SetDefaultDoubleValue (double)
 When DetectNumericColumns is set to true, the reader use this value to populate the vtkDoubleArray where empty strings are found. More...
 
virtual double GetDefaultDoubleValue ()
 When DetectNumericColumns is set to true, the reader use this value to populate the vtkDoubleArray where empty strings are found. More...
 
virtual void SetPedigreeIdArrayName (const char *)
 The name of the array for generating or assigning pedigree ids (default "id"). More...
 
virtual char * GetPedigreeIdArrayName ()
 The name of the array for generating or assigning pedigree ids (default "id"). More...
 
virtual void SetGeneratePedigreeIds (bool)
 If on (default), generates pedigree ids automatically. More...
 
virtual bool GetGeneratePedigreeIds ()
 If on (default), generates pedigree ids automatically. More...
 
virtual void GeneratePedigreeIdsOn ()
 If on (default), generates pedigree ids automatically. More...
 
virtual void GeneratePedigreeIdsOff ()
 If on (default), generates pedigree ids automatically. More...
 
virtual void SetOutputPedigreeIds (bool)
 If on, assigns pedigree ids to output. More...
 
virtual bool GetOutputPedigreeIds ()
 If on, assigns pedigree ids to output. More...
 
virtual void OutputPedigreeIdsOn ()
 If on, assigns pedigree ids to output. More...
 
virtual void OutputPedigreeIdsOff ()
 If on, assigns pedigree ids to output. More...
 
virtual void SetAddTabFieldDelimiter (bool)
 If on, also add in the tab (i.e. More...
 
virtual bool GetAddTabFieldDelimiter ()
 If on, also add in the tab (i.e. More...
 
virtual void AddTabFieldDelimiterOn ()
 If on, also add in the tab (i.e. More...
 
virtual void AddTabFieldDelimiterOff ()
 If on, also add in the tab (i.e. More...
 
virtual void SetReplacementCharacter (vtkTypeUInt32)
 Fallback character for use in the US-ASCII-WITH-FALLBACK character set. More...
 
virtual vtkTypeUInt32 GetReplacementCharacter ()
 Fallback character for use in the US-ASCII-WITH-FALLBACK character set. More...
 
- Public Member Functions inherited from vtkTableAlgorithm
vtkTableAlgorithmNewInstance () const
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkTableGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkTableGetOutput (int index)
 
void SetInputData (vtkDataObject *obj)
 Assign a data object as input. More...
 
void SetInputData (int index, vtkDataObject *obj)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
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. More...
 
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. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
bool CheckAbort ()
 Checks to see if this filter should abort. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
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). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
bool UsesGarbageCollector () const override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm. More...
 
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm. More...
 
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive. More...
 
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (vtkTypeBool)
 Turn release data flag on or off for all output ports. More...
 
virtual vtkTypeBool GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
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. More...
 
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. More...
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
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. More...
 
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. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS(). More...
 
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS(). More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTemporalDelimitedTextReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkTemporalDelimitedTextReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkDelimitedTextReader
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. More...
 
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. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static vtkInformationIntegerKeyABORTED ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- 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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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!). More...
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 This is called by the superclass. More...
 
bool EnforceColumnName ()
 This function checks if a user specified column has been set and check if this input is valid. More...
 
void InternalModified ()
 When parameters specific of this reader are modified, we do not want to re-read the input file. More...
 
- Protected Member Functions inherited from vtkDelimitedTextReader
 vtkDelimitedTextReader ()
 
 ~vtkDelimitedTextReader () override
 
int ReadData (vtkTable *output_table)
 
- Protected Member Functions inherited from vtkTableAlgorithm
 vtkTableAlgorithm ()
 
 ~vtkTableAlgorithm () override
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted. More...
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
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. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
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. More...
 
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. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
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. More...
 
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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
 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< vtkTableReadTable
 
vtkMTimeType LastReadTime = 0
 
vtkTimeStamp InternalMTime
 
- Protected Attributes inherited from vtkDelimitedTextReader
char * FileName
 
vtkTypeBool ReadFromInputString
 
char * InputString
 
int InputStringLength
 
char * UnicodeCharacterSet
 
vtkIdType MaxRecords
 
std::string UnicodeRecordDelimiters
 
std::string UnicodeFieldDelimiters
 
std::string UnicodeStringDelimiters
 
std::string UnicodeWhitespace
 
std::string UnicodeEscapeCharacter
 
bool DetectNumericColumns
 
bool ForceDouble
 
bool TrimWhitespacePriorToNumericConversion
 
int DefaultIntegerValue
 
double DefaultDoubleValue
 
char * FieldDelimiterCharacters
 
char StringDelimiter
 
bool UseStringDelimiter
 
bool HaveHeaders
 
bool MergeConsecutiveDelimiters
 
char * PedigreeIdArrayName
 
bool GeneratePedigreeIds
 
bool OutputPedigreeIds
 
bool AddTabFieldDelimiter
 
vtkStdString LastError
 
vtkTypeUInt32 ReplacementCharacter
 
- Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
 
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBoolAbortExecute
 
- 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 vtkTimeStamp LastAbortTime
 
static vtkExecutiveDefaultExecutivePrototype
 

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
Tests:
vtkTemporalDelimitedTextReader (Tests)

Definition at line 41 of file vtkTemporalDelimitedTextReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 45 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 ( 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 ( 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 mechanism ensures 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 122 of file vtkTemporalDelimitedTextReader.h.

◆ InternalColumnName

std::string vtkTemporalDelimitedTextReader::InternalColumnName
protected

Definition at line 123 of file vtkTemporalDelimitedTextReader.h.

◆ TimeColumnId

vtkIdType vtkTemporalDelimitedTextReader::TimeColumnId = -1
protected

Definition at line 124 of file vtkTemporalDelimitedTextReader.h.

◆ RemoveTimeStepColumn

bool vtkTemporalDelimitedTextReader::RemoveTimeStepColumn = true
protected

Definition at line 125 of file vtkTemporalDelimitedTextReader.h.

◆ TimeMap

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

Definition at line 126 of file vtkTemporalDelimitedTextReader.h.

◆ ReadTable

vtkNew<vtkTable> vtkTemporalDelimitedTextReader::ReadTable
protected

Definition at line 129 of file vtkTemporalDelimitedTextReader.h.

◆ LastReadTime

vtkMTimeType vtkTemporalDelimitedTextReader::LastReadTime = 0
protected

Definition at line 130 of file vtkTemporalDelimitedTextReader.h.

◆ InternalMTime

vtkTimeStamp vtkTemporalDelimitedTextReader::InternalMTime
protected

Definition at line 131 of file vtkTemporalDelimitedTextReader.h.


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