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

#include <vtkDelimitedTextReader.h>

Inheritance diagram for vtkDelimitedTextReader:

Collaboration diagram for vtkDelimitedTextReader:

Public Types
typedef vtkTableAlgorithm	Superclass

Public Types inherited from vtkTableAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkDelimitedTextReader *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

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 ()


virtual char *	GetFileName ()

virtual void	SetFileName (const char *)


void	SetInputString (const char *in)

virtual char *	GetInputString ()

void	SetInputString (const char *in, int len)

virtual int	GetInputStringLength ()

void	SetInputString (const vtkStdString &input)


virtual void	SetReadFromInputString (int)

virtual int	GetReadFromInputString ()

virtual void	ReadFromInputStringOn ()

virtual void	ReadFromInputStringOff ()


virtual char *	GetUnicodeCharacterSet ()

virtual void	SetUnicodeCharacterSet (const char *)


void	SetUTF8RecordDelimiters (const char *delimiters)

const char *	GetUTF8RecordDelimiters ()

void	SetUnicodeRecordDelimiters (const vtkUnicodeString &delimiters)

vtkUnicodeString	GetUnicodeRecordDelimiters ()


virtual void	SetFieldDelimiterCharacters (const char *)

virtual char *	GetFieldDelimiterCharacters ()


virtual char	GetStringDelimiter ()

virtual void	SetStringDelimiter (char)


virtual void	SetUseStringDelimiter (bool)

virtual bool	GetUseStringDelimiter ()

virtual void	UseStringDelimiterOn ()

virtual void	UseStringDelimiterOff ()


virtual bool	GetHaveHeaders ()

virtual void	SetHaveHeaders (bool)


virtual void	SetMergeConsecutiveDelimiters (bool)

virtual bool	GetMergeConsecutiveDelimiters ()

virtual void	MergeConsecutiveDelimitersOn ()

virtual void	MergeConsecutiveDelimitersOff ()


virtual vtkIdType	GetMaxRecords ()

virtual void	SetMaxRecords (vtkIdType)


virtual void	SetDetectNumericColumns (bool)

virtual bool	GetDetectNumericColumns ()

virtual void	DetectNumericColumnsOn ()

virtual void	DetectNumericColumnsOff ()


virtual void	SetForceDouble (bool)

virtual bool	GetForceDouble ()

virtual void	ForceDoubleOn ()

virtual void	ForceDoubleOff ()


virtual void	SetTrimWhitespacePriorToNumericConversion (bool)

virtual bool	GetTrimWhitespacePriorToNumericConversion ()

virtual void	TrimWhitespacePriorToNumericConversionOn ()

virtual void	TrimWhitespacePriorToNumericConversionOff ()


virtual void	SetDefaultIntegerValue (int)

virtual int	GetDefaultIntegerValue ()


virtual void	SetDefaultDoubleValue (double)

virtual double	GetDefaultDoubleValue ()


virtual void	SetPedigreeIdArrayName (const char *)

virtual char *	GetPedigreeIdArrayName ()


virtual void	SetGeneratePedigreeIds (bool)

virtual bool	GetGeneratePedigreeIds ()

virtual void	GeneratePedigreeIdsOn ()

virtual void	GeneratePedigreeIdsOff ()


virtual void	SetOutputPedigreeIds (bool)

virtual bool	GetOutputPedigreeIds ()

virtual void	OutputPedigreeIdsOn ()

virtual void	OutputPedigreeIdsOff ()


virtual void	SetReplacementCharacter (vtkTypeUInt32)

virtual vtkTypeUInt32	GetReplacementCharacter ()

Public Member Functions inherited from vtkTableAlgorithm
vtkTableAlgorithm *	NewInstance () const

virtual int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )

vtkTable *	GetOutput ()

vtkTable *	GetOutput (int index)

void	SetInputData (vtkDataObject *obj)

void	SetInputData (int index, vtkDataObject *obj)

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, unsigned long *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

void	SetProgressText (const char *ptext)

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int extent[6])

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkDelimitedTextReader *	New ()

static int	IsTypeOf (const char *type)

static vtkDelimitedTextReader *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkTableAlgorithm
static vtkTableAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkTableAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

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 ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDelimitedTextReader ()

	~vtkDelimitedTextReader ()

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

Protected Member Functions inherited from vtkTableAlgorithm
	vtkTableAlgorithm ()

	~vtkTableAlgorithm ()

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	FillOutputPortInformation (int port, vtkInformation *info)

virtual int	FillInputPortInformation (int port, vtkInformation *info)

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm ()

virtual void	SetNumberOfInputPorts (int n)

virtual void	SetNumberOfOutputPorts (int n)

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)

virtual vtkExecutive *	CreateDefaultExecutive ()

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	SetNumberOfInputConnections (int port, int n)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

virtual void	SetErrorCode (unsigned long)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
char *	FileName

int	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

vtkStdString	LastError

vtkTypeUInt32	ReplacementCharacter

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

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

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

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

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

This class emits ProgressEvent for every 100 lines it reads.

Thanks:: Thanks to Andy Wilson, Brian Wylie, Tim Shead, and Thomas Otahal from Sandia National Laboratories for implementing this class.

Warning: This reader assumes that the first line in the file (whether that's headers or the first document) contains at least as many fields as any other line in the file.

Examples:: vtkDelimitedTextReader (Examples)

Tests:: vtkDelimitedTextReader (Tests)

Definition at line 77 of file vtkDelimitedTextReader.h.

Member Typedef Documentation

typedef vtkTableAlgorithm vtkDelimitedTextReader::Superclass

Definition at line 81 of file vtkDelimitedTextReader.h.

Constructor & Destructor Documentation

vtkDelimitedTextReader::vtkDelimitedTextReader ( )

protected

vtkDelimitedTextReader::~vtkDelimitedTextReader ( )

protected

Member Function Documentation

static vtkDelimitedTextReader* vtkDelimitedTextReader::New ( )

static

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

static

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

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkTableAlgorithm.

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

static

virtual vtkObjectBase* vtkDelimitedTextReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkTableAlgorithm.

vtkDelimitedTextReader* vtkDelimitedTextReader::NewInstance ( ) const

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

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkTableAlgorithm.

virtual char* vtkDelimitedTextReader::GetFileName ( )

virtual

Specifies the delimited text file to be loaded.

virtual void vtkDelimitedTextReader::SetFileName ( const char * )

virtual

Specifies the delimited text file to be loaded.

void vtkDelimitedTextReader::SetInputString ( const char * in )