VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkDelimitedTextWriter Class Reference

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

#include <vtkDelimitedTextWriter.h>

Inheritance diagram for vtkDelimitedTextWriter:
[legend]
Collaboration diagram for vtkDelimitedTextWriter:
[legend]

Public Types

typedef vtkWriter Superclass
- Public Types inherited from vtkWriter
typedef vtkAlgorithm Superclass
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase 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 ()
- Public Member Functions inherited from vtkWriter
virtual int Write ()
void EncodeString (char *resname, const char *name, bool doublePercent)
void EncodeWriteString (ostream *out, const char *name, bool doublePercent)
void SetInput (vtkDataObject *input)
void SetInput (int index, vtkDataObject *input)
vtkDataObjectGetInput ()
vtkDataObjectGetInput (int port)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
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)
vtkDataObjectGetInputDataObject (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)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkDelimitedTextWriterNew ()
static int IsTypeOf (const char *type)
static vtkDelimitedTextWriterSafeDownCast (vtkObject *o)

Protected Member Functions

bool OpenStream ()
virtual void WriteData ()
virtual void WriteTable (vtkTable *rectilinearGrid)
virtual int FillInputPortInformation (int port, vtkInformation *info)
- Protected Member Functions inherited from vtkWriter
 vtkWriter ()
 ~vtkWriter ()
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual int FillOutputPortInformation (int port, vtkInformation *info)
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 vtkExecutiveCreateDefaultExecutive ()
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)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *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 &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

bool WriteToOutputString
char * OutputString
char * FileName
char * FieldDelimiter
char * StringDelimiter
bool UseStringDelimiter
ostream * Stream
- Protected Attributes inherited from vtkWriter
vtkTimeStamp WriteTime
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
double Progress
char * ProgressText
unsigned long ErrorCode
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers
vtkStdString GetString (vtkStdString string)
 vtkDelimitedTextWriter ()
 ~vtkDelimitedTextWriter ()

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
- Friends inherited from vtkObject

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.

Member Typedef Documentation

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

Implements vtkWriter.

virtual void vtkDelimitedTextWriter::WriteTable ( vtkTable rectilinearGrid)
protectedvirtual
virtual int vtkDelimitedTextWriter::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

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.

Member Data Documentation

bool vtkDelimitedTextWriter::WriteToOutputString
protected

Definition at line 93 of file vtkDelimitedTextWriter.h.

char* vtkDelimitedTextWriter::OutputString
protected

Definition at line 94 of file vtkDelimitedTextWriter.h.

char* vtkDelimitedTextWriter::FileName
protected

Definition at line 105 of file vtkDelimitedTextWriter.h.

char* vtkDelimitedTextWriter::FieldDelimiter
protected

Definition at line 106 of file vtkDelimitedTextWriter.h.

char* vtkDelimitedTextWriter::StringDelimiter
protected

Definition at line 107 of file vtkDelimitedTextWriter.h.

bool vtkDelimitedTextWriter::UseStringDelimiter
protected

Definition at line 108 of file vtkDelimitedTextWriter.h.

ostream* vtkDelimitedTextWriter::Stream
protected

Definition at line 110 of file vtkDelimitedTextWriter.h.


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