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

meta-writer for writing a file series using writers that are not time-aware. More...

#include <vtkFileSeriesWriter.h>

Inherits vtkDataObjectAlgorithm.

Public Types

typedef vtkDataObjectAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkMTimeType GetMTime ()
 Return the MTime also considering the internal writer. More...
 
int Write ()
 Invoke the writer. More...
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 see vtkAlgorithm for details More...
 
void SetInterpreter (vtkClientServerInterpreter *interp)
 Get/Set the interpreter to use to call methods on the writer. More...
 
virtual void SetWriter (vtkAlgorithm *)
 Set/get the internal writer. More...
 
virtual vtkAlgorithm * GetWriter ()
 Set/get the internal writer. More...
 
virtual void SetFileNameMethod (const char *)
 Name of the method used to set the file name of the internal writer. More...
 
virtual char * GetFileNameMethod ()
 Name of the method used to set the file name of the internal writer. More...
 
virtual void SetFileName (const char *)
 Get/Set the name of the output file. More...
 
virtual char * GetFileName ()
 Get/Set the name of the output file. More...
 
virtual int GetWriteAllTimeSteps ()
 Must be set to true to write all timesteps, otherwise only the current timestep will be written out. More...
 
virtual void SetWriteAllTimeSteps (int)
 Must be set to true to write all timesteps, otherwise only the current timestep will be written out. More...
 
virtual void WriteAllTimeStepsOn ()
 Must be set to true to write all timesteps, otherwise only the current timestep will be written out. More...
 
virtual void WriteAllTimeStepsOff ()
 Must be set to true to write all timesteps, otherwise only the current timestep will be written out. More...
 

Static Public Member Functions

static vtkFileSeriesWriterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkFileSeriesWriterSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkFileSeriesWriter ()
 
 ~vtkFileSeriesWriter ()
 
int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 

Detailed Description

meta-writer for writing a file series using writers that are not time-aware.

vtkFileSeriesWriter is a meta-writer that enables writing a file series using writers that are not time-aware.

Definition at line 31 of file vtkFileSeriesWriter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataObjectAlgorithm vtkFileSeriesWriter::Superclass

Definition at line 35 of file vtkFileSeriesWriter.h.

Constructor & Destructor Documentation

◆ vtkFileSeriesWriter()

vtkFileSeriesWriter::vtkFileSeriesWriter ( )
protected

◆ ~vtkFileSeriesWriter()

vtkFileSeriesWriter::~vtkFileSeriesWriter ( )
protected

Member Function Documentation

◆ New()

static vtkFileSeriesWriter* vtkFileSeriesWriter::New ( )
static

◆ GetClassName()

virtual const char* vtkFileSeriesWriter::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ SetWriter()

virtual void vtkFileSeriesWriter::SetWriter ( vtkAlgorithm *  )
virtual

Set/get the internal writer.

◆ GetWriter()

virtual vtkAlgorithm* vtkFileSeriesWriter::GetWriter ( )
virtual

Set/get the internal writer.

◆ GetMTime()

virtual vtkMTimeType vtkFileSeriesWriter::GetMTime ( )
virtual

Return the MTime also considering the internal writer.

◆ SetFileNameMethod()

virtual void vtkFileSeriesWriter::SetFileNameMethod ( const char *  )
virtual

Name of the method used to set the file name of the internal writer.

By default, this is SetFileName.

◆ GetFileNameMethod()

virtual char* vtkFileSeriesWriter::GetFileNameMethod ( )
virtual

Name of the method used to set the file name of the internal writer.

By default, this is SetFileName.

◆ SetFileName()

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

Get/Set the name of the output file.

◆ GetFileName()

virtual char* vtkFileSeriesWriter::GetFileName ( )
virtual

Get/Set the name of the output file.

◆ Write()

int vtkFileSeriesWriter::Write ( )

Invoke the writer.

Returns 1 for success, 0 for failure.

◆ GetWriteAllTimeSteps()

virtual int vtkFileSeriesWriter::GetWriteAllTimeSteps ( )
virtual

Must be set to true to write all timesteps, otherwise only the current timestep will be written out.

Off by default.

◆ SetWriteAllTimeSteps()

virtual void vtkFileSeriesWriter::SetWriteAllTimeSteps ( int  )
virtual

Must be set to true to write all timesteps, otherwise only the current timestep will be written out.

Off by default.

◆ WriteAllTimeStepsOn()

virtual void vtkFileSeriesWriter::WriteAllTimeStepsOn ( )
virtual

Must be set to true to write all timesteps, otherwise only the current timestep will be written out.

Off by default.

◆ WriteAllTimeStepsOff()

virtual void vtkFileSeriesWriter::WriteAllTimeStepsOff ( )
virtual

Must be set to true to write all timesteps, otherwise only the current timestep will be written out.

Off by default.

◆ ProcessRequest()

virtual int vtkFileSeriesWriter::ProcessRequest ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
virtual

see vtkAlgorithm for details

◆ SetInterpreter()

void vtkFileSeriesWriter::SetInterpreter ( vtkClientServerInterpreter interp)
inline

Get/Set the interpreter to use to call methods on the writer.

Definition at line 91 of file vtkFileSeriesWriter.h.

◆ RequestInformation()

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

◆ RequestUpdateExtent()

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

◆ RequestData()

int vtkFileSeriesWriter::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protected

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