ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCSVWriter Class Reference

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

#include <vtkCSVWriter.h>

Inherits vtkWriter.

Public Types

typedef vtkWriter Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetFieldDelimiter (const char *)
 Get/Set the delimiter use to separate fields ("," by default.) More...
 
virtual char * GetFieldDelimiter ()
 Get/Set the delimiter use to separate fields ("," by default.) More...
 
virtual void SetStringDelimiter (const char *)
 Get/Set the delimiter used for string data, if any eg. More...
 
virtual char * GetStringDelimiter ()
 Get/Set the delimiter used for string data, if any eg. More...
 
virtual void SetFileName (const char *)
 Get/Set the filename for the file. More...
 
virtual char * GetFileName ()
 Get/Set the filename for the file. More...
 
virtual void SetUseStringDelimiter (bool)
 Get/Set if StringDelimiter must be used for string data. More...
 
virtual bool GetUseStringDelimiter ()
 Get/Set if StringDelimiter must be used for string data. More...
 
virtual void SetPrecision (int)
 Get/Set the precision to use for printing numeric values. More...
 
virtual int GetPrecision ()
 Get/Set the precision to use for printing numeric values. More...
 
virtual void SetUseScientificNotation (bool)
 Get/Set whether scientific notation is used for numeric values. More...
 
virtual bool GetUseScientificNotation ()
 Get/Set whether scientific notation is used for numeric values. More...
 
virtual void UseScientificNotationOn ()
 Get/Set whether scientific notation is used for numeric values. More...
 
virtual void UseScientificNotationOff ()
 Get/Set whether scientific notation is used for numeric values. More...
 

Static Public Member Functions

static vtkCSVWriterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkCSVWriterSafeDownCast (vtkObject *o)
 

Protected Member Functions

bool OpenFile ()
 
virtual void WriteData ()
 
virtual void WriteTable (vtkTable *rectilinearGrid)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 

Protected Attributes

char * FileName
 
char * FieldDelimiter
 
char * StringDelimiter
 
bool UseStringDelimiter
 
int Precision
 
bool UseScientificNotation
 
ofstream * Stream
 
vtkStdString GetString (vtkStdString string)
 Internal method: decortes the "string" with the "StringDelimiter" if UseStringDelimiter is true. More...
 
 vtkCSVWriter ()
 Internal method: decortes the "string" with the "StringDelimiter" if UseStringDelimiter is true. More...
 
 ~vtkCSVWriter ()
 Internal method: decortes the "string" with the "StringDelimiter" if UseStringDelimiter is true. More...
 

Detailed Description

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

Definition at line 30 of file vtkCSVWriter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkWriter vtkCSVWriter::Superclass

Definition at line 34 of file vtkCSVWriter.h.

Constructor & Destructor Documentation

◆ vtkCSVWriter()

vtkCSVWriter::vtkCSVWriter ( )
protected

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

◆ ~vtkCSVWriter()

vtkCSVWriter::~vtkCSVWriter ( )
protected

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

Member Function Documentation

◆ New()

static vtkCSVWriter* vtkCSVWriter::New ( )
static

◆ GetClassName()

virtual const char* vtkCSVWriter::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

virtual int vtkCSVWriter::IsA ( const char *  type)
virtual

◆ SafeDownCast()

static vtkCSVWriter* vtkCSVWriter::SafeDownCast ( vtkObject *  o)
static

◆ PrintSelf()

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

◆ SetFieldDelimiter()

virtual void vtkCSVWriter::SetFieldDelimiter ( const char *  )
virtual

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

◆ GetFieldDelimiter()

virtual char* vtkCSVWriter::GetFieldDelimiter ( )
virtual

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

◆ SetStringDelimiter()

virtual void vtkCSVWriter::SetStringDelimiter ( const char *  )
virtual

Get/Set the delimiter used for string data, if any eg.

double quotes(").

◆ GetStringDelimiter()

virtual char* vtkCSVWriter::GetStringDelimiter ( )
virtual

Get/Set the delimiter used for string data, if any eg.

double quotes(").

◆ SetFileName()

virtual void vtkCSVWriter::SetFileName ( const char *  )
virtual

Get/Set the filename for the file.

◆ GetFileName()

virtual char* vtkCSVWriter::GetFileName ( )
virtual

Get/Set the filename for the file.

◆ SetUseStringDelimiter()

virtual void vtkCSVWriter::SetUseStringDelimiter ( bool  )
virtual

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

True by default.

◆ GetUseStringDelimiter()

virtual bool vtkCSVWriter::GetUseStringDelimiter ( )
virtual

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

True by default.

◆ SetPrecision()

virtual void vtkCSVWriter::SetPrecision ( int  )
virtual

Get/Set the precision to use for printing numeric values.

Default is 5.

◆ GetPrecision()

virtual int vtkCSVWriter::GetPrecision ( )
virtual

Get/Set the precision to use for printing numeric values.

Default is 5.

◆ SetUseScientificNotation()

virtual void vtkCSVWriter::SetUseScientificNotation ( bool  )
virtual

Get/Set whether scientific notation is used for numeric values.

◆ GetUseScientificNotation()

virtual bool vtkCSVWriter::GetUseScientificNotation ( )
virtual

Get/Set whether scientific notation is used for numeric values.

◆ UseScientificNotationOn()

virtual void vtkCSVWriter::UseScientificNotationOn ( )
virtual

Get/Set whether scientific notation is used for numeric values.

◆ UseScientificNotationOff()

virtual void vtkCSVWriter::UseScientificNotationOff ( )
virtual

Get/Set whether scientific notation is used for numeric values.

◆ GetString()

vtkStdString vtkCSVWriter::GetString ( vtkStdString  string)

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

◆ OpenFile()

bool vtkCSVWriter::OpenFile ( )
protected

◆ WriteData()

virtual void vtkCSVWriter::WriteData ( )
protectedvirtual

◆ WriteTable()

virtual void vtkCSVWriter::WriteTable ( vtkTable *  rectilinearGrid)
protectedvirtual

◆ FillInputPortInformation()

virtual int vtkCSVWriter::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

Member Data Documentation

◆ FileName

char* vtkCSVWriter::FileName
protected

Definition at line 110 of file vtkCSVWriter.h.

◆ FieldDelimiter

char* vtkCSVWriter::FieldDelimiter
protected

Definition at line 111 of file vtkCSVWriter.h.

◆ StringDelimiter

char* vtkCSVWriter::StringDelimiter
protected

Definition at line 112 of file vtkCSVWriter.h.

◆ UseStringDelimiter

bool vtkCSVWriter::UseStringDelimiter
protected

Definition at line 113 of file vtkCSVWriter.h.

◆ Precision

int vtkCSVWriter::Precision
protected

Definition at line 114 of file vtkCSVWriter.h.

◆ UseScientificNotation

bool vtkCSVWriter::UseScientificNotation
protected

Definition at line 115 of file vtkCSVWriter.h.

◆ Stream

ofstream* vtkCSVWriter::Stream
protected

Definition at line 117 of file vtkCSVWriter.h.


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