vtkDelimitedTextWriter Class Reference

#include <vtkDelimitedTextWriter.h>

Inheritance diagram for vtkDelimitedTextWriter:

[legend]

Collaboration diagram for vtkDelimitedTextWriter:

[legend]

List of all members.

Detailed Description

Delimited text writer for vtkTable Writes a vtkTable as a delimited text file (such as CSV).

Examples:: vtkDelimitedTextWriter (Examples)

Tests:: vtkDelimitedTextWriter (Tests)

Definition at line 40 of file vtkDelimitedTextWriter.h.


vtkStdString	GetString (vtkStdString string)
	vtkDelimitedTextWriter ()
	~vtkDelimitedTextWriter ()
Public Types
typedef vtkWriter	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
char *	RegisterAndGetOutputString ()

virtual void	SetFieldDelimiter (const char *)
virtual char *	GetFieldDelimiter ()

virtual void	SetStringDelimiter (const char *)
virtual char *	GetStringDelimiter ()

virtual void	SetFileName (const char *)
virtual char *	GetFileName ()

virtual void	SetUseStringDelimiter (bool)
virtual bool	GetUseStringDelimiter ()

virtual void	SetWriteToOutputString (bool)
virtual bool	GetWriteToOutputString ()
virtual void	WriteToOutputStringOn ()
virtual void	WriteToOutputStringOff ()
Static Public Member Functions
static vtkDelimitedTextWriter *	New ()
static int	IsTypeOf (const char *type)
static vtkDelimitedTextWriter *	SafeDownCast (vtkObject *o)
Protected Member Functions
bool	OpenStream ()
virtual void	WriteData ()
virtual void	WriteTable (vtkTable *rectilinearGrid)
virtual int	FillInputPortInformation (int port, vtkInformation *info)
Protected Attributes
bool	WriteToOutputString
char *	OutputString
char *	FileName
char *	FieldDelimiter
char *	StringDelimiter
bool	UseStringDelimiter
ostream *	Stream

Member Typedef Documentation

typedef vtkWriter vtkDelimitedTextWriter::Superclass

Reimplemented from vtkWriter.

Definition at line 44 of file vtkDelimitedTextWriter.h.

Constructor & Destructor Documentation

vtkDelimitedTextWriter::vtkDelimitedTextWriter ( ) [protected]

Internal method: Returns the "string" with the "StringDelimiter" if UseStringDelimiter is true.

vtkDelimitedTextWriter::~vtkDelimitedTextWriter ( ) [protected]

Internal method: Returns the "string" with the "StringDelimiter" if UseStringDelimiter is true.

Member Function Documentation

static vtkDelimitedTextWriter* vtkDelimitedTextWriter::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

virtual const char* vtkDelimitedTextWriter::GetClassName ( ) [virtual]

Reimplemented from vtkWriter.

static int vtkDelimitedTextWriter::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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 vtkWriter.

virtual int vtkDelimitedTextWriter::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 vtkWriter.

static vtkDelimitedTextWriter* vtkDelimitedTextWriter::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkWriter.

void vtkDelimitedTextWriter::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 vtkWriter.

virtual void vtkDelimitedTextWriter::SetFieldDelimiter ( const char * ) [virtual]

Get/Set the delimiter use to separate fields ("," by default.)

virtual char* vtkDelimitedTextWriter::GetFieldDelimiter ( ) [virtual]

Get/Set the delimiter use to separate fields ("," by default.)

virtual void vtkDelimitedTextWriter::SetStringDelimiter ( const char * ) [virtual]

Get/Set the delimiter used for string data, if any eg. double quotes(").

virtual char* vtkDelimitedTextWriter::GetStringDelimiter ( ) [virtual]

Get/Set the delimiter used for string data, if any eg. double quotes(").

virtual void vtkDelimitedTextWriter::SetFileName ( const char * ) [virtual]

Get/Set the filename for the file.

virtual char* vtkDelimitedTextWriter::GetFileName ( ) [virtual]

Get/Set the filename for the file.

virtual void vtkDelimitedTextWriter::SetUseStringDelimiter ( bool ) [virtual]

Get/Set if StringDelimiter must be used for string data. True by default.

virtual bool vtkDelimitedTextWriter::GetUseStringDelimiter ( ) [virtual]

Get/Set if StringDelimiter must be used for string data. True by default.

virtual void vtkDelimitedTextWriter::SetWriteToOutputString ( bool ) [virtual]

Enable writing to an OutputString instead of the default, a file.

virtual bool vtkDelimitedTextWriter::GetWriteToOutputString ( ) [virtual]

Enable writing to an OutputString instead of the default, a file.

virtual void vtkDelimitedTextWriter::WriteToOutputStringOn ( ) [virtual]

Enable writing to an OutputString instead of the default, a file.

virtual void vtkDelimitedTextWriter::WriteToOutputStringOff ( ) [virtual]

Enable writing to an OutputString instead of the default, a file.

char* vtkDelimitedTextWriter::RegisterAndGetOutputString ( )

This convenience method returns the string, sets the IVAR to NULL, so that the user is responsible for deleting the string.

vtkStdString vtkDelimitedTextWriter::GetString ( vtkStdString string )

Internal method: Returns the "string" with the "StringDelimiter" if UseStringDelimiter is true.

bool vtkDelimitedTextWriter::OpenStream ( ) [protected]

virtual void vtkDelimitedTextWriter::WriteData ( ) [protected, virtual]

Implements vtkWriter.

virtual void vtkDelimitedTextWriter::WriteTable ( vtkTable * rectilinearGrid ) [protected, virtual]

virtual int vtkDelimitedTextWriter::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)			`[protected, virtual]`

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.