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

#include <vtkFileSeriesWriter.h>

Inheritance diagram for vtkFileSeriesWriter:

Collaboration diagram for vtkFileSeriesWriter:

[legend]

Public Types
typedef vtkDataObjectAlgorithm	Superclass

Public Types inherited from vtkDataObjectAlgorithm
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

vtkMTimeType	GetMTime () override
	Return the MTime also considering the internal writer. More...

int	Write ()
	Invoke the writer. More...

int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	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 ()
	If Off, which is the default, only the current timestep is written. More...

virtual void	SetWriteAllTimeSteps (int)
	If Off, which is the default, only the current timestep is written. More...

virtual void	WriteAllTimeStepsOn ()
	If Off, which is the default, only the current timestep is written. More...

virtual void	WriteAllTimeStepsOff ()
	If Off, which is the default, only the current timestep is written. More...


virtual bool	GetWriteJsonMetaFile ()
	If true, write a .series json meta file when writing all time steps. More...

virtual void	SetWriteJsonMetaFile (bool)
	If true, write a .series json meta file when writing all time steps. More...

virtual void	WriteJsonMetaFileOn ()
	If true, write a .series json meta file when writing all time steps. More...

virtual void	WriteJsonMetaFileOff ()
	If true, write a .series json meta file when writing all time steps. 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 int	GetMinTimeStep ()
	Sets a minimum timestep constraint on WriteAllTimeSteps. More...

virtual void	SetMinTimeStep (int)
	Sets a minimum timestep constraint on WriteAllTimeSteps. More...


virtual int	GetMaxTimeStep ()
	Sets a maximum timestep constraint on WriteAllTimeSteps. More...

virtual void	SetMaxTimeStep (int)
	Sets a maximum timestep constraint on WriteAllTimeSteps. More...


virtual int	GetTimeStepStride ()
	Sets a stride to write out time series. More...

virtual void	SetTimeStepStride (int)
	Sets a stride to write out time series. More...

Public Member Functions inherited from vtkDataObjectAlgorithm
vtkDataObjectAlgorithm *	NewInstance () const

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

vtkDataObject *	GetOutput ()

vtkDataObject *	GetOutput (int)

virtual void	SetOutput (vtkDataObject *d)

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

void	AddInputData (vtkDataObject *)

void	AddInputData (int, vtkDataObject *)

vtkDataObject *	GetOutput ()

vtkDataObject *	GetOutput (int)

virtual void	SetOutput (vtkDataObject *d)

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

void	AddInputData (vtkDataObject *)

void	AddInputData (int, vtkDataObject *)

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (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 ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (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 vtkInformation *	GetInformation ()

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)

vtkDataObject *	GetInputDataObject (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)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

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)

int *	GetUpdateExtent ()

int *	GetUpdateExtent (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 vtkProgressObserver *	GetProgressObserver ()

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)

virtual vtkInformation *	GetInformation ()

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)

vtkDataObject *	GetInputDataObject (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)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

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)

int *	GetUpdateExtent ()

int *	GetUpdateExtent (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 vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

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)

vtkCommand *	GetCommand (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)

vtkCommand *	GetCommand (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 vtkFileSeriesWriter *	New ()

static int	IsTypeOf (const char *type)

static vtkFileSeriesWriter *	SafeDownCast (vtkObject *o)

static bool	SuffixValidation (char *fileNameSuffix)
	Utility function for validating the file name suffix. More...

Static Public Member Functions inherited from vtkDataObjectAlgorithm
static vtkDataObjectAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkDataObjectAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

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 vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkFileSeriesWriter ()

	~vtkFileSeriesWriter () override

int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override

int	RequestUpdateExtent (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override

int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override

Protected Member Functions inherited from vtkDataObjectAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDataObjectAlgorithm ()

	~vtkDataObjectAlgorithm ()

virtual int	FillOutputPortInformation (int port, vtkInformation *info)

virtual int	FillInputPortInformation (int port, vtkInformation *info)

virtual int	RequestDataObject (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	RequestDataObject (vtkInformation , vtkInformationVector , vtkInformationVector )

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm ()

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 vtkExecutive *	CreateDefaultExecutive ()

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)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (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)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (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 &)

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
	SINGLE_PRECISION

	DOUBLE_PRECISION

	DEFAULT_PRECISION

int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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 19 of file vtkFileSeriesWriter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataObjectAlgorithm vtkFileSeriesWriter::Superclass

Definition at line 23 of file vtkFileSeriesWriter.h.

Constructor & Destructor Documentation

◆ vtkFileSeriesWriter()

vtkFileSeriesWriter::vtkFileSeriesWriter ( )

protected

◆ ~vtkFileSeriesWriter()

vtkFileSeriesWriter::~vtkFileSeriesWriter ( )

overrideprotected

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

Reimplemented from vtkDataObjectAlgorithm.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ SetWriter()

virtual void vtkFileSeriesWriter::SetWriter ( vtkAlgorithm * )

virtual

Set/get the internal writer.

◆ GetWriter()

virtual vtkAlgorithm* vtkFileSeriesWriter::GetWriter ( )

virtual

Set/get the internal writer.

◆ GetMTime()

vtkMTimeType vtkFileSeriesWriter::GetMTime ( )

overridevirtual

Return the MTime also considering the internal writer.

Reimplemented from vtkObject.

◆ 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

If Off, which is the default, only the current timestep is written.

If true the writer will write every timestep, or at least those within the range of min to max.

◆ SetWriteAllTimeSteps()

virtual void vtkFileSeriesWriter::SetWriteAllTimeSteps ( int )

virtual

If Off, which is the default, only the current timestep is written.

If true the writer will write every timestep, or at least those within the range of min to max.

◆ WriteAllTimeStepsOn()

virtual void vtkFileSeriesWriter::WriteAllTimeStepsOn ( )

virtual

If Off, which is the default, only the current timestep is written.

If true the writer will write every timestep, or at least those within the range of min to max.

◆ WriteAllTimeStepsOff()

virtual void vtkFileSeriesWriter::WriteAllTimeStepsOff ( )

virtual

If Off, which is the default, only the current timestep is written.

If true the writer will write every timestep, or at least those within the range of min to max.

◆ GetWriteJsonMetaFile()

virtual bool vtkFileSeriesWriter::GetWriteJsonMetaFile ( )

virtual

If true, write a .series json meta file when writing all time steps.

Default is false.

◆ SetWriteJsonMetaFile()

virtual void vtkFileSeriesWriter::SetWriteJsonMetaFile ( bool )

virtual

If true, write a .series json meta file when writing all time steps.

Default is false.

◆ WriteJsonMetaFileOn()

virtual void vtkFileSeriesWriter::WriteJsonMetaFileOn ( )

virtual

If true, write a .series json meta file when writing all time steps.

Default is false.

◆ WriteJsonMetaFileOff()

virtual void vtkFileSeriesWriter::WriteJsonMetaFileOff ( )

virtual

If true, write a .series json meta file when writing all time steps.

Default is false.

◆ GetFileNameSuffix()

virtual char* vtkFileSeriesWriter::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 vtkFileSeriesWriter::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.

◆ GetMinTimeStep()

virtual int vtkFileSeriesWriter::GetMinTimeStep ( )

virtual

Sets a minimum timestep constraint on WriteAllTimeSteps.

◆ SetMinTimeStep()

virtual void vtkFileSeriesWriter::SetMinTimeStep ( int )

virtual

Sets a minimum timestep constraint on WriteAllTimeSteps.

◆ GetMaxTimeStep()

virtual int vtkFileSeriesWriter::GetMaxTimeStep ( )

virtual

Sets a maximum timestep constraint on WriteAllTimeSteps.

If less than MinTimeStep, then the MaxTimeStep constraint is ignored (i.e. all time steps from MinTimeStep to the actual last time step are written out).

◆ SetMaxTimeStep()

virtual void vtkFileSeriesWriter::SetMaxTimeStep ( int )

virtual

Sets a maximum timestep constraint on WriteAllTimeSteps.

If less than MinTimeStep, then the MaxTimeStep constraint is ignored (i.e. all time steps from MinTimeStep to the actual last time step are written out).

◆ GetTimeStepStride()

virtual int vtkFileSeriesWriter::GetTimeStepStride ( )

virtual

Sets a stride to write out time series.

◆ SetTimeStepStride()

virtual void vtkFileSeriesWriter::SetTimeStepStride ( int )

virtual

Sets a stride to write out time series.

◆ ProcessRequest()

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

overridevirtual

see vtkAlgorithm for details

Reimplemented from vtkDataObjectAlgorithm.

◆ SetInterpreter()

void vtkFileSeriesWriter::SetInterpreter ( vtkClientServerInterpreter * interp )

inline

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

Definition at line 128 of file vtkFileSeriesWriter.h.

◆ SuffixValidation()

static bool vtkFileSeriesWriter::SuffixValidation ( char * fileNameSuffix )

static

Utility function for validating the file name suffix.

◆ RequestInformation()

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

overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ RequestUpdateExtent()

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

overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ RequestData()

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

overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

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

/builds/gitlab-kitware-sciviz-ci/VTKExtensions/IOCore/vtkFileSeriesWriter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkFileSeriesWriter()

◆ ~vtkFileSeriesWriter()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetWriter()

◆ GetWriter()

◆ GetMTime()

◆ SetFileNameMethod()

◆ GetFileNameMethod()

◆ SetFileName()

◆ GetFileName()

◆ Write()

◆ GetWriteAllTimeSteps()

◆ SetWriteAllTimeSteps()

◆ WriteAllTimeStepsOn()

◆ WriteAllTimeStepsOff()

◆ GetWriteJsonMetaFile()

◆ SetWriteJsonMetaFile()

◆ WriteJsonMetaFileOn()

◆ WriteJsonMetaFileOff()

◆ GetFileNameSuffix()

◆ SetFileNameSuffix()

◆ GetMinTimeStep()

◆ SetMinTimeStep()

◆ GetMaxTimeStep()

◆ SetMaxTimeStep()

◆ GetTimeStepStride()

◆ SetTimeStepStride()

◆ ProcessRequest()

◆ SetInterpreter()

◆ SuffixValidation()

◆ RequestInformation()

◆ RequestUpdateExtent()

◆ RequestData()