ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Private Member Functions
Kitware.VTK.vtkDelimitedTextReader Class Reference

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

Inheritance diagram for Kitware.VTK.vtkDelimitedTextReader:
[legend]
Collaboration diagram for Kitware.VTK.vtkDelimitedTextReader:
[legend]

List of all members.

Public Member Functions

 vtkDelimitedTextReader (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkDelimitedTextReader ()
 *Undocumented Block
virtual void DetectNumericColumnsOff ()
 When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray. Default is off.
virtual void DetectNumericColumnsOn ()
 When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray. Default is off.
virtual void GeneratePedigreeIdsOff ()
 If on (default), generates pedigree ids automatically. If off, assign one of the arrays to be the pedigree id.
virtual void GeneratePedigreeIdsOn ()
 If on (default), generates pedigree ids automatically. If off, assign one of the arrays to be the pedigree id.
virtual bool GetDetectNumericColumns ()
 When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray. Default is off.
virtual string GetFieldDelimiterCharacters ()
 Specify the character(s) that will be used to separate fields. For example, set this to "," for a comma-separated value file. Set it to ".:;" for a file where columns can be separated by a period, colon or semicolon. The order of the characters in the string does not matter. Defaults to a comma.
virtual string GetFileName ()
 Specifies the delimited text file to be loaded.
virtual bool GetGeneratePedigreeIds ()
 If on (default), generates pedigree ids automatically. If off, assign one of the arrays to be the pedigree id.
virtual bool GetHaveHeaders ()
 Set/get whether to treat the first line of the file as headers.
virtual int GetMaxRecords ()
 Specifies the maximum number of records to read from the file. Limiting the number of records to read is useful for previewing the contents of a file.
virtual bool GetMergeConsecutiveDelimiters ()
 Set/get whether to merge successive delimiters. Use this if (for example) your fields are separated by spaces but you don't know exactly how many.
virtual bool GetOutputPedigreeIds ()
 If on, assigns pedigree ids to output. Defaults to off.
virtual string GetPedigreeIdArrayName ()
 The name of the array for generating or assigning pedigree ids (default "id").
virtual uint GetReplacementCharacter ()
 Fallback character for use in the US-ASCII-WITH-FALLBACK character set. Any characters that have their 8th bit set will be replaced with this code point. Defaults to 'x'.
virtual sbyte GetStringDelimiter ()
 Get/set the character that will begin and end strings. Microsoft Excel, for example, will export the following format:
string GetUTF8FieldDelimiters ()
 Specify the character(s) that will be used to separate fields. For example, set this to "," for a comma-separated value file. Set it to ".:;" for a file where columns can be separated by a period, colon or semicolon. The order of the characters in the string does not matter. Defaults to a comma.
string GetUTF8RecordDelimiters ()
 Specify the character(s) that will be used to separate records. The order of characters in the string does not matter. Defaults to "
".
string GetUTF8StringDelimiters ()
 Get/set the character that will begin and end strings. Microsoft Excel, for example, will export the following format:
virtual string GetUnicodeCharacterSet ()
 Specifies the character set used in the input file. Valid character set names will be drawn from the list maintained by the Internet Assigned Name Authority at.
virtual bool GetUseStringDelimiter ()
 Set/get whether to use the string delimiter. Defaults to on.
override int IsA (string type)
 *Undocumented Block
virtual void MergeConsecutiveDelimitersOff ()
 Set/get whether to merge successive delimiters. Use this if (for example) your fields are separated by spaces but you don't know exactly how many.
virtual void MergeConsecutiveDelimitersOn ()
 Set/get whether to merge successive delimiters. Use this if (for example) your fields are separated by spaces but you don't know exactly how many.
new vtkDelimitedTextReader NewInstance ()
 *Undocumented Block
virtual void OutputPedigreeIdsOff ()
 If on, assigns pedigree ids to output. Defaults to off.
virtual void OutputPedigreeIdsOn ()
 If on, assigns pedigree ids to output. Defaults to off.
virtual void SetDetectNumericColumns (bool _arg)
 When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray. Default is off.
virtual void SetFieldDelimiterCharacters (string _arg)
 Specify the character(s) that will be used to separate fields. For example, set this to "," for a comma-separated value file. Set it to ".:;" for a file where columns can be separated by a period, colon or semicolon. The order of the characters in the string does not matter. Defaults to a comma.
virtual void SetFileName (string _arg)
 Specifies the delimited text file to be loaded.
virtual void SetGeneratePedigreeIds (bool _arg)
 If on (default), generates pedigree ids automatically. If off, assign one of the arrays to be the pedigree id.
virtual void SetHaveHeaders (bool _arg)
 Set/get whether to treat the first line of the file as headers.
virtual void SetMaxRecords (int _arg)
 Specifies the maximum number of records to read from the file. Limiting the number of records to read is useful for previewing the contents of a file.
virtual void SetMergeConsecutiveDelimiters (bool _arg)
 Set/get whether to merge successive delimiters. Use this if (for example) your fields are separated by spaces but you don't know exactly how many.
virtual void SetOutputPedigreeIds (bool _arg)
 If on, assigns pedigree ids to output. Defaults to off.
virtual void SetPedigreeIdArrayName (string _arg)
 The name of the array for generating or assigning pedigree ids (default "id").
virtual void SetReplacementCharacter (uint _arg)
 Fallback character for use in the US-ASCII-WITH-FALLBACK character set. Any characters that have their 8th bit set will be replaced with this code point. Defaults to 'x'.
virtual void SetStringDelimiter (sbyte _arg)
 Get/set the character that will begin and end strings. Microsoft Excel, for example, will export the following format:
void SetUTF8FieldDelimiters (string delimiters)
 Specify the character(s) that will be used to separate fields. For example, set this to "," for a comma-separated value file. Set it to ".:;" for a file where columns can be separated by a period, colon or semicolon. The order of the characters in the string does not matter. Defaults to a comma.
void SetUTF8RecordDelimiters (string delimiters)
 Specify the character(s) that will be used to separate records. The order of characters in the string does not matter. Defaults to "
".
void SetUTF8StringDelimiters (string delimiters)
 Get/set the character that will begin and end strings. Microsoft Excel, for example, will export the following format:
virtual void SetUnicodeCharacterSet (string _arg)
 Specifies the character set used in the input file. Valid character set names will be drawn from the list maintained by the Internet Assigned Name Authority at.
virtual void SetUseStringDelimiter (bool _arg)
 Set/get whether to use the string delimiter. Defaults to on.
virtual void UseStringDelimiterOff ()
 Set/get whether to use the string delimiter. Defaults to on.
virtual void UseStringDelimiterOn ()
 Set/get whether to use the string delimiter. Defaults to on.
- Public Member Functions inherited from Kitware.VTK.vtkTableAlgorithm
 vtkTableAlgorithm (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkTableAlgorithm ()
 *Undocumented Block
vtkTable GetOutput ()
 Get the output data object for a port on this algorithm.
vtkTable GetOutput (int index)
 Get the output data object for a port on this algorithm.
void SetInput (vtkDataObject obj)
 Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
void SetInput (int index, vtkDataObject obj)
 Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
- Public Member Functions inherited from Kitware.VTK.vtkAlgorithm
 vtkAlgorithm (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkAlgorithm ()
 *Undocumented Block
override void Register (vtkObjectBase o)
 Participate in garbage collection.
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void AddInputConnection (int port, vtkAlgorithmOutput input)
 Add a connection to the given input port index. See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is.
virtual void AddInputConnection (vtkAlgorithmOutput input)
 Add a connection to the given input port index. See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is.
virtual double ComputePriority ()
 Returns the priority of the piece described by the current update extent. The priority is a number between 0.0 and 1.0 with 0 meaning skippable (REQUEST_DATA not needed) and 1.0 meaning important.
void ConvertTotalInputToPortConnection (int ind, ref int port, ref int conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual int GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual uint GetErrorCode ()
 The error code contains a possible error that occured while reading or writing the file.
vtkExecutive GetExecutive ()
 Get this algorithm's executive. If it has none, a default executive will be created.
virtual vtkInformation GetInformation ()
 Set/Get the information object associated with this algorithm.
vtkInformation GetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
vtkAlgorithmOutput GetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
vtkDataObject GetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection.
vtkInformation GetInputPortInformation (int port)
 Get the information object associated with an input port. There is one input port per kind of input to the algorithm. Each input port tells executives what kind of data and downstream requests this algorithm can handle for that input.
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a 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.
vtkDataObject GetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
vtkAlgorithmOutput GetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity.
vtkAlgorithmOutput GetOutputPort ()
 Get a proxy object corresponding to the given output port of this algorithm. The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity.
vtkInformation GetOutputPortInformation (int port)
 Get the information object associated with an output port. There is one output port per output from the algorithm. Each output port tells executives what kind of upstream requests this algorithm can handle for that output.
virtual double GetProgress ()
 Set/Get the execution progress of a process object.
virtual double GetProgressMaxValue ()
 Set/Get the execution progress of a process object.
virtual double GetProgressMinValue ()
 Set/Get the execution progress of a process object.
virtual string GetProgressText ()
 Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports.
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm.
int HasExecutive ()
 Check whether this algorithm has an assigned executive. This will NOT create a default executive.
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. The default implementation is empty. Returns 1 on success, 0 on failure. When can be either vtkExecutive::BeforeForward or vtkExecutive::AfterForward.
int ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector outInfo)
 Version of ProcessRequest() that is wrapped. This converts the collection to an array and calls the other version.
void ReleaseDataFlagOff ()
 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 RemoveAllInputs ()
 Remove all the input data.
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput input)
 Remove a connection from the given input port index. See SetInputConnection() for details on input connection. This method is the complement to AddInputConnection() in that it removes only the connection specified without affecting other connections. Typical usage is.
virtual void SetAbortExecute (int _arg)
 Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void SetExecutive (vtkExecutive executive)
 Set this algorithm's executive. This algorithm is removed from any executive to which it has previously been assigned and then assigned to the given executive.
virtual void SetInformation (vtkInformation arg0)
 Set/Get the information object associated with this algorithm.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, string name)
 Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void SetInputArrayToProcess (int idx, vtkInformation info)
 Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void SetInputArrayToProcess (int idx, int port, int connection, string fieldAssociation, string attributeTypeorName)
 String based versions of SetInputArrayToProcess(). Because fieldAssociation and fieldAttributeType are enums, they cannot be easily accessed from scripting language. These methods provides an easy and safe way of passing association and attribute type information. Field association is one of the following:
virtual void SetInputConnection (int port, vtkAlgorithmOutput input)
 Set the connection for the given input port index. Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().
virtual void SetInputConnection (vtkAlgorithmOutput input)
 Set the connection for the given input port index. Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().
virtual void SetProgress (double _arg)
 Set/Get the execution progress of a process object.
void SetProgressText (string ptext)
 Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().
virtual void SetReleaseDataFlag (int arg0)
 Turn release data flag on or off for all output ports.
virtual void Update ()
 Bring this algorithm's outputs up-to-date.
int UpdateExtentIsEmpty (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. The source uses this call to determine whether to call Execute.
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. The source uses this call to determine whether to call Execute.
virtual void UpdateInformation ()
 Backward compatibility method to invoke UpdateInformation on executive.
void UpdateProgress (double amount)
 Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
virtual uint GetMTime ()
 Return this object's modified time.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static new vtkDelimitedTextReader New ()
 *Undocumented Block
static new int IsTypeOf (string type)
 *Undocumented Block
static new vtkDelimitedTextReader SafeDownCast (vtkObjectBase o)
 *Undocumented Block

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkDelimitedTextReader"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkTableAlgorithm
- Public Attributes inherited from Kitware.VTK.vtkAlgorithm
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "22vtkDelimitedTextReader"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkTableAlgorithm
- Static Public Attributes inherited from Kitware.VTK.vtkAlgorithm
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions

static vtkDelimitedTextReader ()
 Automatically generated type registration mechanics.

Detailed Description

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

Description 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.

Caveats

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.


Constructor & Destructor Documentation

static Kitware.VTK.vtkDelimitedTextReader.vtkDelimitedTextReader ( )
staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkDelimitedTextReader.vtkDelimitedTextReader ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkDelimitedTextReader.vtkDelimitedTextReader ( )

*Undocumented Block


Member Function Documentation

virtual void Kitware.VTK.vtkDelimitedTextReader.DetectNumericColumnsOff ( )
virtual

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

virtual void Kitware.VTK.vtkDelimitedTextReader.DetectNumericColumnsOn ( )
virtual

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

override void Kitware.VTK.vtkDelimitedTextReader.Dispose ( bool  disposing)
protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkTableAlgorithm.

virtual void Kitware.VTK.vtkDelimitedTextReader.GeneratePedigreeIdsOff ( )
virtual

If on (default), generates pedigree ids automatically. If off, assign one of the arrays to be the pedigree id.

virtual void Kitware.VTK.vtkDelimitedTextReader.GeneratePedigreeIdsOn ( )
virtual

If on (default), generates pedigree ids automatically. If off, assign one of the arrays to be the pedigree id.

virtual bool Kitware.VTK.vtkDelimitedTextReader.GetDetectNumericColumns ( )
virtual

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

virtual string Kitware.VTK.vtkDelimitedTextReader.GetFieldDelimiterCharacters ( )
virtual

Specify the character(s) that will be used to separate fields. For example, set this to "," for a comma-separated value file. Set it to ".:;" for a file where columns can be separated by a period, colon or semicolon. The order of the characters in the string does not matter. Defaults to a comma.

virtual string Kitware.VTK.vtkDelimitedTextReader.GetFileName ( )
virtual

Specifies the delimited text file to be loaded.

virtual bool Kitware.VTK.vtkDelimitedTextReader.GetGeneratePedigreeIds ( )
virtual

If on (default), generates pedigree ids automatically. If off, assign one of the arrays to be the pedigree id.

virtual bool Kitware.VTK.vtkDelimitedTextReader.GetHaveHeaders ( )
virtual

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

virtual int Kitware.VTK.vtkDelimitedTextReader.GetMaxRecords ( )
virtual

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

virtual bool Kitware.VTK.vtkDelimitedTextReader.GetMergeConsecutiveDelimiters ( )
virtual

Set/get whether to merge successive delimiters. Use this if (for example) your fields are separated by spaces but you don't know exactly how many.

virtual bool Kitware.VTK.vtkDelimitedTextReader.GetOutputPedigreeIds ( )
virtual

If on, assigns pedigree ids to output. Defaults to off.

virtual string Kitware.VTK.vtkDelimitedTextReader.GetPedigreeIdArrayName ( )
virtual

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

virtual uint Kitware.VTK.vtkDelimitedTextReader.GetReplacementCharacter ( )
virtual

Fallback character for use in the US-ASCII-WITH-FALLBACK character set. Any characters that have their 8th bit set will be replaced with this code point. Defaults to 'x'.

virtual sbyte Kitware.VTK.vtkDelimitedTextReader.GetStringDelimiter ( )
virtual

Get/set the character that will begin and end strings. Microsoft Excel, for example, will export the following format:

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

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

virtual string Kitware.VTK.vtkDelimitedTextReader.GetUnicodeCharacterSet ( )
virtual

Specifies the character set used in the input file. Valid character set names will be drawn from the list maintained by the Internet Assigned Name Authority at.

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

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

virtual bool Kitware.VTK.vtkDelimitedTextReader.GetUseStringDelimiter ( )
virtual

Set/get whether to use the string delimiter. Defaults to on.

string Kitware.VTK.vtkDelimitedTextReader.GetUTF8FieldDelimiters ( )

Specify the character(s) that will be used to separate fields. For example, set this to "," for a comma-separated value file. Set it to ".:;" for a file where columns can be separated by a period, colon or semicolon. The order of the characters in the string does not matter. Defaults to a comma.

string Kitware.VTK.vtkDelimitedTextReader.GetUTF8RecordDelimiters ( )

Specify the character(s) that will be used to separate records. The order of characters in the string does not matter. Defaults to "
".

string Kitware.VTK.vtkDelimitedTextReader.GetUTF8StringDelimiters ( )

Get/set the character that will begin and end strings. Microsoft Excel, for example, will export the following format:

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

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

override int Kitware.VTK.vtkDelimitedTextReader.IsA ( string  type)
virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkTableAlgorithm.

static new int Kitware.VTK.vtkDelimitedTextReader.IsTypeOf ( string  type)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkTableAlgorithm.

virtual void Kitware.VTK.vtkDelimitedTextReader.MergeConsecutiveDelimitersOff ( )
virtual

Set/get whether to merge successive delimiters. Use this if (for example) your fields are separated by spaces but you don't know exactly how many.

virtual void Kitware.VTK.vtkDelimitedTextReader.MergeConsecutiveDelimitersOn ( )
virtual

Set/get whether to merge successive delimiters. Use this if (for example) your fields are separated by spaces but you don't know exactly how many.

static new vtkDelimitedTextReader Kitware.VTK.vtkDelimitedTextReader.New ( )
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkTableAlgorithm.

new vtkDelimitedTextReader Kitware.VTK.vtkDelimitedTextReader.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkTableAlgorithm.

virtual void Kitware.VTK.vtkDelimitedTextReader.OutputPedigreeIdsOff ( )
virtual

If on, assigns pedigree ids to output. Defaults to off.

virtual void Kitware.VTK.vtkDelimitedTextReader.OutputPedigreeIdsOn ( )
virtual

If on, assigns pedigree ids to output. Defaults to off.

static new vtkDelimitedTextReader Kitware.VTK.vtkDelimitedTextReader.SafeDownCast ( vtkObjectBase  o)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkTableAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkDelimitedTextReader.SetDetectNumericColumns ( bool  _arg)
virtual

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

virtual void Kitware.VTK.vtkDelimitedTextReader.SetFieldDelimiterCharacters ( string  _arg)
virtual

Specify the character(s) that will be used to separate fields. For example, set this to "," for a comma-separated value file. Set it to ".:;" for a file where columns can be separated by a period, colon or semicolon. The order of the characters in the string does not matter. Defaults to a comma.

virtual void Kitware.VTK.vtkDelimitedTextReader.SetFileName ( string  _arg)
virtual

Specifies the delimited text file to be loaded.

virtual void Kitware.VTK.vtkDelimitedTextReader.SetGeneratePedigreeIds ( bool  _arg)
virtual

If on (default), generates pedigree ids automatically. If off, assign one of the arrays to be the pedigree id.

virtual void Kitware.VTK.vtkDelimitedTextReader.SetHaveHeaders ( bool  _arg)
virtual

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

virtual void Kitware.VTK.vtkDelimitedTextReader.SetMaxRecords ( int  _arg)
virtual

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

virtual void Kitware.VTK.vtkDelimitedTextReader.SetMergeConsecutiveDelimiters ( bool  _arg)
virtual

Set/get whether to merge successive delimiters. Use this if (for example) your fields are separated by spaces but you don't know exactly how many.

virtual void Kitware.VTK.vtkDelimitedTextReader.SetOutputPedigreeIds ( bool  _arg)
virtual

If on, assigns pedigree ids to output. Defaults to off.

virtual void Kitware.VTK.vtkDelimitedTextReader.SetPedigreeIdArrayName ( string  _arg)
virtual

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

virtual void Kitware.VTK.vtkDelimitedTextReader.SetReplacementCharacter ( uint  _arg)
virtual

Fallback character for use in the US-ASCII-WITH-FALLBACK character set. Any characters that have their 8th bit set will be replaced with this code point. Defaults to 'x'.

virtual void Kitware.VTK.vtkDelimitedTextReader.SetStringDelimiter ( sbyte  _arg)
virtual

Get/set the character that will begin and end strings. Microsoft Excel, for example, will export the following format:

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

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

virtual void Kitware.VTK.vtkDelimitedTextReader.SetUnicodeCharacterSet ( string  _arg)
virtual

Specifies the character set used in the input file. Valid character set names will be drawn from the list maintained by the Internet Assigned Name Authority at.

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

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

virtual void Kitware.VTK.vtkDelimitedTextReader.SetUseStringDelimiter ( bool  _arg)
virtual

Set/get whether to use the string delimiter. Defaults to on.

void Kitware.VTK.vtkDelimitedTextReader.SetUTF8FieldDelimiters ( string  delimiters)

Specify the character(s) that will be used to separate fields. For example, set this to "," for a comma-separated value file. Set it to ".:;" for a file where columns can be separated by a period, colon or semicolon. The order of the characters in the string does not matter. Defaults to a comma.

void Kitware.VTK.vtkDelimitedTextReader.SetUTF8RecordDelimiters ( string  delimiters)

Specify the character(s) that will be used to separate records. The order of characters in the string does not matter. Defaults to "
".

void Kitware.VTK.vtkDelimitedTextReader.SetUTF8StringDelimiters ( string  delimiters)

Get/set the character that will begin and end strings. Microsoft Excel, for example, will export the following format:

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

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

virtual void Kitware.VTK.vtkDelimitedTextReader.UseStringDelimiterOff ( )
virtual

Set/get whether to use the string delimiter. Defaults to on.

virtual void Kitware.VTK.vtkDelimitedTextReader.UseStringDelimiterOn ( )
virtual

Set/get whether to use the string delimiter. Defaults to on.


Member Data Documentation

new readonly string Kitware.VTK.vtkDelimitedTextReader.MRClassNameKey = "22vtkDelimitedTextReader"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkTableAlgorithm.

new const string Kitware.VTK.vtkDelimitedTextReader.MRFullTypeName = "Kitware.VTK.vtkDelimitedTextReader"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkTableAlgorithm.


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