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/vtkDataSet/vtkCompositeDataSet Writes a vtkTable/vtkDataSet/vtkCompositeDataSet as a delimited text file (such as CSV). More...

#include <vtkCSVWriter.h>

Inheritance diagram for vtkCSVWriter:
Inheritance graph
[legend]
Collaboration diagram for vtkCSVWriter:
Collaboration graph
[legend]

Public Types

typedef vtkWriter Superclass
 
- Public Types inherited from vtkWriter
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision
 
enum  DesiredOutputPrecision
 
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetController (vtkMultiProcessController *)
 Get/Set the controller to use. More...
 
virtual vtkMultiProcessControllerGetController ()
 Get/Set the controller to use. More...
 
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 SetWriteAllTimeSteps (bool)
 When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader. More...
 
virtual bool GetWriteAllTimeSteps ()
 When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader. More...
 
virtual void WriteAllTimeStepsOn ()
 When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader. More...
 
virtual void WriteAllTimeStepsOff ()
 When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader. More...
 
virtual void SetWriteAllTimeStepsSeparately (bool)
 When WriteAllTimeStepsSeparately is turned ON and WriteAllTimeSteps is ON, the writer is executed once for each timestep available from its input, and writes the timesteps to separate files, otherwise, the timesteps are written in one file. More...
 
virtual bool GetWriteAllTimeStepsSeparately ()
 When WriteAllTimeStepsSeparately is turned ON and WriteAllTimeSteps is ON, the writer is executed once for each timestep available from its input, and writes the timesteps to separate files, otherwise, the timesteps are written in one file. More...
 
virtual void WriteAllTimeStepsSeparatelyOn ()
 When WriteAllTimeStepsSeparately is turned ON and WriteAllTimeSteps is ON, the writer is executed once for each timestep available from its input, and writes the timesteps to separate files, otherwise, the timesteps are written in one file. More...
 
virtual void WriteAllTimeStepsSeparatelyOff ()
 When WriteAllTimeStepsSeparately is turned ON and WriteAllTimeSteps is ON, the writer is executed once for each timestep available from its input, and writes the timesteps to separate files, otherwise, the timesteps are written in one file. More...
 
virtual char * GetFileNameSuffix ()
 Provides an option to pad the time step when writing out time series data. More...
 
virtual void SetFileNameSuffix (const char *)
 Provides an option to pad the time step when writing out time series data. 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...
 
virtual void SetFieldAssociation (int)
 Get/set the attribute data to write if the input is either a vtkDataSet or composite of vtkDataSets. More...
 
virtual int GetFieldAssociation ()
 Get/set the attribute data to write if the input is either a vtkDataSet or composite of vtkDataSets. More...
 
virtual void SetAddMetaData (bool)
 Get/Set whether to add additional meta-data to the field data such as point coordinates (when point attributes are selected and input is pointset) or structured coordinates etc. More...
 
virtual bool GetAddMetaData ()
 Get/Set whether to add additional meta-data to the field data such as point coordinates (when point attributes are selected and input is pointset) or structured coordinates etc. More...
 
virtual void AddMetaDataOn ()
 Get/Set whether to add additional meta-data to the field data such as point coordinates (when point attributes are selected and input is pointset) or structured coordinates etc. More...
 
virtual void AddMetaDataOff ()
 Get/Set whether to add additional meta-data to the field data such as point coordinates (when point attributes are selected and input is pointset) or structured coordinates etc. More...
 
virtual void SetAddTime (bool)
 When set to true (default is false), if the input data set has time, then the time information will be saved under the column named "Time". More...
 
virtual bool GetAddTime ()
 When set to true (default is false), if the input data set has time, then the time information will be saved under the column named "Time". More...
 
virtual void AddTimeOn ()
 When set to true (default is false), if the input data set has time, then the time information will be saved under the column named "Time". More...
 
virtual void AddTimeOff ()
 When set to true (default is false), if the input data set has time, then the time information will be saved under the column named "Time". More...
 
virtual void SetAddTimeStep (bool)
 When set to true (default is false), if the input data set has time, then the time-step information will be saved under the column named "TimeStep". More...
 
virtual bool GetAddTimeStep ()
 When set to true (default is false), if the input data set has time, then the time-step information will be saved under the column named "TimeStep". More...
 
virtual void AddTimeStepOn ()
 When set to true (default is false), if the input data set has time, then the time-step information will be saved under the column named "TimeStep". More...
 
virtual void AddTimeStepOff ()
 When set to true (default is false), if the input data set has time, then the time-step information will be saved under the column named "TimeStep". More...
 
std::string GetString (std::string string)
 Internal method: decorates the "string" with the "StringDelimiter" if UseStringDelimiter is true. More...
 
- Public Member Functions inherited from vtkWriter
vtkWriterNewInstance () const
 
virtual int Write ()
 
void EncodeString (char *resname, const char *name, bool doublePercent)
 
void EncodeWriteString (ostream *out, const char *name, bool doublePercent)
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
void SetInputData (vtkDataObject *input)
 
void SetInputData (int index, vtkDataObject *input)
 
void SetInputData (vtkDataObject *input)
 
void SetInputData (int index, vtkDataObject *input)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
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)
 
virtual void RemoveInputConnection (int port, int idx)
 
virtual void RemoveAllInputConnections (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformationGetInputInformation (int port, int index)
 
vtkInformationGetOutputInformation (int port)
 
virtual int Update (int port, vtkInformationVector *requests)
 
virtual int Update (vtkInformation *requests)
 
virtual int UpdateExtent (const int extents[6])
 
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])
 
void SetUpdateExtent (int extent[6])
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
void Register (vtkObjectBase *o) VTK_OVERRIDE
 
void UnRegister (vtkObjectBase *o) VTK_OVERRIDE
 
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)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformationGetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)
 
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)
 
intGetUpdateExtent ()
 
intGetUpdateExtent (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 vtkProgressObserverGetProgressObserver ()
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
void Register (vtkObjectBase *o) VTK_OVERRIDE
 
void UnRegister (vtkObjectBase *o) VTK_OVERRIDE
 
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)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformationGetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)
 
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)
 
intGetUpdateExtent ()
 
intGetUpdateExtent (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 vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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 *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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)
 
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 *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkCSVWriterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkCSVWriterSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkWriter
static int IsTypeOf (const char *type)
 
static vtkWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkCSVWriter ()
 
 ~vtkCSVWriter () override
 
void WriteData () override
 
int FillInputPortInformation (int port, vtkInformation *info) override
 
int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
- Protected Member Functions inherited from vtkWriter
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkWriter ()
 
 ~vtkWriter ()
 
- 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 ()
 
void ReportReferences (vtkGarbageCollector *) VTK_OVERRIDE
 
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)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
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 SetErrorCode (unsigned long)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
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
 
bool WriteAllTimeSteps
 
bool WriteAllTimeStepsSeparately
 
char * FileNameSuffix
 
char * FieldDelimiter
 
char * StringDelimiter
 
bool UseStringDelimiter
 
int Precision
 
bool UseScientificNotation
 
int FieldAssociation
 
bool AddMetaData
 
bool AddTimeStep
 
bool AddTime
 
vtkMultiProcessControllerController
 
vtkDoubleArrayTimeValues
 
int CurrentTimeIndex
 
int NumberOfTimeSteps
 
- Protected Attributes inherited from vtkWriter
vtkTimeStamp WriteTime
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
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
 SINGLE_PRECISION
 
 DOUBLE_PRECISION
 
 DEFAULT_PRECISION
 
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

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

Definition at line 23 of file vtkCSVWriter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 27 of file vtkCSVWriter.h.

Constructor & Destructor Documentation

◆ vtkCSVWriter()

vtkCSVWriter::vtkCSVWriter ( )
protected

◆ ~vtkCSVWriter()

vtkCSVWriter::~vtkCSVWriter ( )
overrideprotected

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

Reimplemented from vtkWriter.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkWriter.

◆ SetController()

void vtkCSVWriter::SetController ( vtkMultiProcessController )

Get/Set the controller to use.

By default, vtkMultiProcessController::GetGlobalController will be used.

◆ GetController()

virtual vtkMultiProcessController* vtkCSVWriter::GetController ( )
virtual

Get/Set the controller to use.

By default, vtkMultiProcessController::GetGlobalController will be used.

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

◆ SetWriteAllTimeSteps()

virtual void vtkCSVWriter::SetWriteAllTimeSteps ( bool  )
virtual

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

The Default is OFF.

◆ GetWriteAllTimeSteps()

virtual bool vtkCSVWriter::GetWriteAllTimeSteps ( )
virtual

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

The Default is OFF.

◆ WriteAllTimeStepsOn()

virtual void vtkCSVWriter::WriteAllTimeStepsOn ( )
virtual

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

The Default is OFF.

◆ WriteAllTimeStepsOff()

virtual void vtkCSVWriter::WriteAllTimeStepsOff ( )
virtual

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

The Default is OFF.

◆ SetWriteAllTimeStepsSeparately()

virtual void vtkCSVWriter::SetWriteAllTimeStepsSeparately ( bool  )
virtual

When WriteAllTimeStepsSeparately is turned ON and WriteAllTimeSteps is ON, the writer is executed once for each timestep available from its input, and writes the timesteps to separate files, otherwise, the timesteps are written in one file.

The Default is OFF.

◆ GetWriteAllTimeStepsSeparately()

virtual bool vtkCSVWriter::GetWriteAllTimeStepsSeparately ( )
virtual

When WriteAllTimeStepsSeparately is turned ON and WriteAllTimeSteps is ON, the writer is executed once for each timestep available from its input, and writes the timesteps to separate files, otherwise, the timesteps are written in one file.

The Default is OFF.

◆ WriteAllTimeStepsSeparatelyOn()

virtual void vtkCSVWriter::WriteAllTimeStepsSeparatelyOn ( )
virtual

When WriteAllTimeStepsSeparately is turned ON and WriteAllTimeSteps is ON, the writer is executed once for each timestep available from its input, and writes the timesteps to separate files, otherwise, the timesteps are written in one file.

The Default is OFF.

◆ WriteAllTimeStepsSeparatelyOff()

virtual void vtkCSVWriter::WriteAllTimeStepsSeparatelyOff ( )
virtual

When WriteAllTimeStepsSeparately is turned ON and WriteAllTimeSteps is ON, the writer is executed once for each timestep available from its input, and writes the timesteps to separate files, otherwise, the timesteps are written in one file.

The Default is OFF.

◆ GetFileNameSuffix()

virtual char* vtkCSVWriter::GetFileNameSuffix ( )
virtual

Provides an option to pad the time step when writing out time series data.

Only allow this format: ABC%.Xd where ABC is an arbitrary string which may or may not exist and d must exist and d must be the last character '.' and X may or may not exist, X must be an integer if it exists. Default is nullptr.

◆ SetFileNameSuffix()

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

Provides an option to pad the time step when writing out time series data.

Only allow this format: ABC%.Xd where ABC is an arbitrary string which may or may not exist and d must exist and d must be the last character '.' and X may or may not exist, X must be an integer if it exists. Default is nullptr.

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

◆ SetFieldAssociation()

virtual void vtkCSVWriter::SetFieldAssociation ( int  )
virtual

Get/set the attribute data to write if the input is either a vtkDataSet or composite of vtkDataSets.

0 is for point data (vtkDataObject::POINT), 1 is for cell data (vtkDataObject::CELL) and 2 is for field data (vtkDataObject::FIELD). Default is 0.

◆ GetFieldAssociation()

virtual int vtkCSVWriter::GetFieldAssociation ( )
virtual

Get/set the attribute data to write if the input is either a vtkDataSet or composite of vtkDataSets.

0 is for point data (vtkDataObject::POINT), 1 is for cell data (vtkDataObject::CELL) and 2 is for field data (vtkDataObject::FIELD). Default is 0.

◆ SetAddMetaData()

virtual void vtkCSVWriter::SetAddMetaData ( bool  )
virtual

Get/Set whether to add additional meta-data to the field data such as point coordinates (when point attributes are selected and input is pointset) or structured coordinates etc.

if the input is either a vtkDataSet or composite of vtkDataSets.

◆ GetAddMetaData()

virtual bool vtkCSVWriter::GetAddMetaData ( )
virtual

Get/Set whether to add additional meta-data to the field data such as point coordinates (when point attributes are selected and input is pointset) or structured coordinates etc.

if the input is either a vtkDataSet or composite of vtkDataSets.

◆ AddMetaDataOn()

virtual void vtkCSVWriter::AddMetaDataOn ( )
virtual

Get/Set whether to add additional meta-data to the field data such as point coordinates (when point attributes are selected and input is pointset) or structured coordinates etc.

if the input is either a vtkDataSet or composite of vtkDataSets.

◆ AddMetaDataOff()

virtual void vtkCSVWriter::AddMetaDataOff ( )
virtual

Get/Set whether to add additional meta-data to the field data such as point coordinates (when point attributes are selected and input is pointset) or structured coordinates etc.

if the input is either a vtkDataSet or composite of vtkDataSets.

◆ SetAddTime()

virtual void vtkCSVWriter::SetAddTime ( bool  )
virtual

When set to true (default is false), if the input data set has time, then the time information will be saved under the column named "Time".

◆ GetAddTime()

virtual bool vtkCSVWriter::GetAddTime ( )
virtual

When set to true (default is false), if the input data set has time, then the time information will be saved under the column named "Time".

◆ AddTimeOn()

virtual void vtkCSVWriter::AddTimeOn ( )
virtual

When set to true (default is false), if the input data set has time, then the time information will be saved under the column named "Time".

◆ AddTimeOff()

virtual void vtkCSVWriter::AddTimeOff ( )
virtual

When set to true (default is false), if the input data set has time, then the time information will be saved under the column named "Time".

◆ SetAddTimeStep()

virtual void vtkCSVWriter::SetAddTimeStep ( bool  )
virtual

When set to true (default is false), if the input data set has time, then the time-step information will be saved under the column named "TimeStep".

◆ GetAddTimeStep()

virtual bool vtkCSVWriter::GetAddTimeStep ( )
virtual

When set to true (default is false), if the input data set has time, then the time-step information will be saved under the column named "TimeStep".

◆ AddTimeStepOn()

virtual void vtkCSVWriter::AddTimeStepOn ( )
virtual

When set to true (default is false), if the input data set has time, then the time-step information will be saved under the column named "TimeStep".

◆ AddTimeStepOff()

virtual void vtkCSVWriter::AddTimeStepOff ( )
virtual

When set to true (default is false), if the input data set has time, then the time-step information will be saved under the column named "TimeStep".

◆ GetString()

std::string vtkCSVWriter::GetString ( std::string  string)

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

◆ WriteData()

void vtkCSVWriter::WriteData ( )
overrideprotectedvirtual

Implements vtkWriter.

◆ FillInputPortInformation()

int vtkCSVWriter::FillInputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Reimplemented from vtkAlgorithm.

◆ RequestInformation()

int vtkCSVWriter::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protected

◆ RequestUpdateExtent()

int vtkCSVWriter::RequestUpdateExtent ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protected

◆ RequestData()

int vtkCSVWriter::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

Reimplemented from vtkWriter.

◆ ProcessRequest()

int vtkCSVWriter::ProcessRequest ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

Reimplemented from vtkWriter.

Member Data Documentation

◆ FileName

char* vtkCSVWriter::FileName
protected

Definition at line 201 of file vtkCSVWriter.h.

◆ WriteAllTimeSteps

bool vtkCSVWriter::WriteAllTimeSteps
protected

Definition at line 202 of file vtkCSVWriter.h.

◆ WriteAllTimeStepsSeparately

bool vtkCSVWriter::WriteAllTimeStepsSeparately
protected

Definition at line 203 of file vtkCSVWriter.h.

◆ FileNameSuffix

char* vtkCSVWriter::FileNameSuffix
protected

Definition at line 204 of file vtkCSVWriter.h.

◆ FieldDelimiter

char* vtkCSVWriter::FieldDelimiter
protected

Definition at line 205 of file vtkCSVWriter.h.

◆ StringDelimiter

char* vtkCSVWriter::StringDelimiter
protected

Definition at line 206 of file vtkCSVWriter.h.

◆ UseStringDelimiter

bool vtkCSVWriter::UseStringDelimiter
protected

Definition at line 207 of file vtkCSVWriter.h.

◆ Precision

int vtkCSVWriter::Precision
protected

Definition at line 208 of file vtkCSVWriter.h.

◆ UseScientificNotation

bool vtkCSVWriter::UseScientificNotation
protected

Definition at line 209 of file vtkCSVWriter.h.

◆ FieldAssociation

int vtkCSVWriter::FieldAssociation
protected

Definition at line 210 of file vtkCSVWriter.h.

◆ AddMetaData

bool vtkCSVWriter::AddMetaData
protected

Definition at line 211 of file vtkCSVWriter.h.

◆ AddTimeStep

bool vtkCSVWriter::AddTimeStep
protected

Definition at line 212 of file vtkCSVWriter.h.

◆ AddTime

bool vtkCSVWriter::AddTime
protected

Definition at line 213 of file vtkCSVWriter.h.

◆ Controller

vtkMultiProcessController* vtkCSVWriter::Controller
protected

Definition at line 215 of file vtkCSVWriter.h.

◆ TimeValues

vtkDoubleArray* vtkCSVWriter::TimeValues
protected

Definition at line 217 of file vtkCSVWriter.h.

◆ CurrentTimeIndex

int vtkCSVWriter::CurrentTimeIndex
protected

Definition at line 218 of file vtkCSVWriter.h.

◆ NumberOfTimeSteps

int vtkCSVWriter::NumberOfTimeSteps
protected

Definition at line 219 of file vtkCSVWriter.h.


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