meta-reader to read file series More...

#include <vtkFileSeriesReader.h>

Inheritance diagram for vtkFileSeriesReader:

[legend]

Collaboration diagram for vtkFileSeriesReader:

[legend]

Public Types
typedef vtkMetaReader	Superclass

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

int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	All pipeline passes are forwarded to the internal reader. More...

virtual int	CanReadFile (const char *filename)
	CanReadFile is forwarded to the internal reader if it supports it. More...

virtual void	AddFileName (const char *fname)
	Adds names of files to be read. More...

virtual void	RemoveAllFileNames ()
	Remove all file names. More...

virtual unsigned int	GetNumberOfFileNames ()
	Returns the number of file names added by AddFileName. More...

virtual const char *	GetFileName (unsigned int idx)
	Returns the name of a file with index idx. More...

const char *	GetCurrentFileName ()

unsigned long	GetErrorCode () override
	Return the error code of the reader. More...


virtual int	GetUseMetaFile ()
	If true, then use the meta file. More...

virtual void	SetUseMetaFile (int)
	If true, then use the meta file. More...

virtual void	UseMetaFileOn ()
	If true, then use the meta file. More...

virtual void	UseMetaFileOff ()
	If true, then use the meta file. More...


virtual bool	GetIgnoreReaderTime ()
	If true, then treat file series like it does not contain any time step values. More...

virtual void	SetIgnoreReaderTime (bool)
	If true, then treat file series like it does not contain any time step values. More...

virtual void	IgnoreReaderTimeOn ()
	If true, then treat file series like it does not contain any time step values. More...

virtual void	IgnoreReaderTimeOff ()
	If true, then treat file series like it does not contain any time step values. More...

Public Member Functions inherited from vtkMetaReader
	vtkMetaReader ()

	~vtkMetaReader () override

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

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual void	SetReader (vtkAlgorithm *)
	Set/get the internal reader. More...

virtual vtkAlgorithm *	GetReader ()
	Set/get the internal reader. More...

void	SetMetaFileName (const char *name)
	Get/set the filename for the meta-file. More...

char *	GetMetaFileName ()
	Get/set the filename for the meta-file. More...

virtual vtkIdType *	GetFileIndexRange ()
	Returns the available range of file indexes. More...

virtual void	GetFileIndexRange (vtkIdType &, vtkIdType &)
	Returns the available range of file indexes. More...

virtual void	GetFileIndexRange (vtkIdType [2])
	Returns the available range of file indexes. More...

vtkIdType	GetFileIndex ()
	Get/set the index of the file to read. More...

void	SetFileIndex (vtkIdType i)
	Get/set the index of the file to read. More...

virtual void	SetFileNameMethod (const char *)
	Name of the method used to set the file name of the internal reader. More...

virtual char *	GetFileNameMethod ()
	Name of the method used to set the file name of the internal reader. 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 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 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 vtkFileSeriesReader *	New ()

static int	IsTypeOf (const char *type)

static vtkFileSeriesReader *	SafeDownCast (vtkObject *o)

static vtkInformationIntegerKey *	FILE_SERIES_NUMBER_OF_FILES ()

static vtkInformationIntegerKey *	FILE_SERIES_CURRENT_FILE_NUMBER ()

static vtkInformationStringKey *	FILE_SERIES_FIRST_FILENAME ()

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

static int	IsTypeOf (const char *type)

static vtkMetaReader *	SafeDownCast (vtkObject *o)

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

	~vtkFileSeriesReader () override

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

int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector ) override

int	RequestUpdateTime (vtkInformation , vtkInformationVector , vtkInformationVector ) override

virtual int	RequestUpdateTimeDependentInformation (vtkInformation , vtkInformationVector , vtkInformationVector )

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

int	FillOutputPortInformation (int port, vtkInformation *info) override

virtual int	RequestInformationForInput (int index, vtkInformation request=nullptr, vtkInformationVector outputVector=nullptr)
	Make sure the reader's output is set to the given index and, if it changed, run RequestInformation on the reader. More...

virtual int	ReadMetaDataFile (const char metafilename, vtkStringArray filesToRead, std::vector< double > &timeValues, int maxFilesToRead=VTK_INT_MAX)
	Reads a metadata file and returns a list of filenames (in filesToRead). More...

virtual void	UpdateMetaData ()
	Re-reads information from the metadata file, if necessary. More...

void	ResetTimeRanges ()
	Resets information about TimeRanges. More...

void	RemoveAllFileNamesInternal ()
	Add/Remove filenames without changing the MTime. More...

void	AddFileNameInternal (const char *)

virtual void	RemoveAllRealFileNamesInternal ()
	Remove all real file names. More...

void	CopyRealFileNamesFromFileNames ()
	Set the real filenames to those in the internal FileNames. More...

int	ChooseInput (vtkInformation *)

Protected Member Functions inherited from vtkMetaReader
int	FillOutputPortInformation (int port, vtkInformation *info) override

virtual void	Set_MetaFileName (const char *)

virtual char *	Get_MetaFileName ()

virtual void	Set_FileIndex (vtkIdType)

virtual vtkIdType	Get_FileIndex ()

void	ReaderSetFileName (const char *filename)

int	ReaderCanReadFile (const char *filename)

std::string	FromRelativeToMetaFile (const char metaFileName, const char fileName)
	'metaFileName' to either a file path that is relative to the current working directory (CWD) or to an absolute file path. More...

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

	vtkDataObjectAlgorithm ()

	~vtkDataObjectAlgorithm ()

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 &)

Protected Attributes
int	UseMetaFile
	True if use a meta-file, false otherwise. More...

bool	UseJsonMetaFile
	True if meta-file is of Json format, false otherwise. More...

bool	IgnoreReaderTime

Protected Attributes inherited from vtkMetaReader
vtkAlgorithm *	Reader

vtkMTimeType	FileNameMTime

vtkMTimeType	BeforeFileNameMTime

char *	FileNameMethod

vtkIdType	_FileIndex

vtkMTimeType	FileIndexMTime

vtkIdType	FileIndexRange [2]

char *	_MetaFileName

vtkMTimeType	MetaFileNameMTime

vtkTimeStamp	MetaFileReadTime
	Records the time when the meta-file was read. More...

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

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

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

meta-reader to read file series

vtkFileSeriesReader is a meta-reader that can work with various readers to load file series. To the pipeline, it looks like a reader that supports time. It updates the file name to the internal reader whenever a different time step is requested.

If the reader already supports time, then this meta-filter will multiplex the time. It will union together all the times and forward time requests to the file with the correct time. Overlaps are handled by requesting data from the file with the upper range the farthest in the future.

There are three ways to specify a series of files. The first way is by adding the filenames one at a time with the AddFileName method.

The second way is by providing (with the AddFileName method) a meta file that specifies a list of files. This format allows the user to specify a time value in addition to a filename for each step. The format is as follows:

* {
* "file-series-version" : "version",
* "files" : [
* { "name" : "filename1", "time" : timeValue1 },
* { "name" : "filename2", "time" : timeValue2 },
* ...
* ]
* }
*

Here is an example:

* {
* "file-series-version" : "1.0",
* "files" : [
* { "name" : "foo1.vtk", "time" : 0 },
* { "name" : "foo2.vtk", "time" : 5.5 },
* { "name" : "foo3.vtk", "time" : 11.2 }]
* }
*

The current version is 1.0.

The third way is by providing a single meta file which is a simple text file that lists a file per line. The files can be relative to the meta file. This method is useful when the actual reader points to a set of files itself. The UseMetaFile enables this method of specifying the files. The filename is set with SetMetaFileName in this case. Do not use the AddFileName() method when using SetMetaFileName() as names set with AddFileName() will be ignored.

Definition at line 74 of file vtkFileSeriesReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMetaReader vtkFileSeriesReader::Superclass

Definition at line 78 of file vtkFileSeriesReader.h.

Constructor & Destructor Documentation

◆ vtkFileSeriesReader()

vtkFileSeriesReader::vtkFileSeriesReader ( )

protected

◆ ~vtkFileSeriesReader()

vtkFileSeriesReader::~vtkFileSeriesReader ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkFileSeriesReader* vtkFileSeriesReader::New ( )

static

◆ GetClassName()

virtual const char* vtkFileSeriesReader::GetClassName ( )

virtual

Reimplemented from vtkMetaReader.

Reimplemented in vtkExodusFileSeriesReader, vtkImageFileSeriesReader, vtkRawImageFileSeriesReader, vtkSpyPlotFileSeriesReader, and vtkAMRFileSeriesReader.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkMetaReader.

Reimplemented in vtkExodusFileSeriesReader, vtkImageFileSeriesReader, vtkRawImageFileSeriesReader, vtkSpyPlotFileSeriesReader, and vtkAMRFileSeriesReader.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented in vtkExodusFileSeriesReader, vtkImageFileSeriesReader, vtkRawImageFileSeriesReader, and vtkSpyPlotFileSeriesReader.

◆ ProcessRequest()

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

overridevirtual

All pipeline passes are forwarded to the internal reader.

The vtkFileSeriesReader reports time steps in RequestInformation. It updated the file name of the internal in RequestUpdateExtent based on the time step request.

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented in vtkImageFileSeriesReader.

◆ CanReadFile()

virtual int vtkFileSeriesReader::CanReadFile ( const char * filename )

virtual

CanReadFile is forwarded to the internal reader if it supports it.

◆ AddFileName()

virtual void vtkFileSeriesReader::AddFileName ( const char * fname )

virtual

Adds names of files to be read.

The files are read in the order they are added.

◆ RemoveAllFileNames()

virtual void vtkFileSeriesReader::RemoveAllFileNames ( )

virtual

Remove all file names.

◆ GetNumberOfFileNames()

virtual unsigned int vtkFileSeriesReader::GetNumberOfFileNames ( )

virtual

Returns the number of file names added by AddFileName.

◆ GetFileName()

virtual const char* vtkFileSeriesReader::GetFileName ( unsigned int idx )

virtual

Returns the name of a file with index idx.

◆ GetCurrentFileName()

const char* vtkFileSeriesReader::GetCurrentFileName ( )

◆ GetUseMetaFile()

virtual int vtkFileSeriesReader::GetUseMetaFile ( )

virtual

If true, then use the meta file.

False by default.

◆ SetUseMetaFile()

virtual void vtkFileSeriesReader::SetUseMetaFile ( int )

virtual

If true, then use the meta file.

False by default.

◆ UseMetaFileOn()

virtual void vtkFileSeriesReader::UseMetaFileOn ( )

virtual

If true, then use the meta file.

False by default.

◆ UseMetaFileOff()

virtual void vtkFileSeriesReader::UseMetaFileOff ( )

virtual

If true, then use the meta file.

False by default.

◆ GetIgnoreReaderTime()

virtual bool vtkFileSeriesReader::GetIgnoreReaderTime ( )

virtual

If true, then treat file series like it does not contain any time step values.

False by default.

◆ SetIgnoreReaderTime()

virtual void vtkFileSeriesReader::SetIgnoreReaderTime ( bool )

virtual

If true, then treat file series like it does not contain any time step values.

False by default.

◆ IgnoreReaderTimeOn()

virtual void vtkFileSeriesReader::IgnoreReaderTimeOn ( )

virtual

If true, then treat file series like it does not contain any time step values.

False by default.

◆ IgnoreReaderTimeOff()

virtual void vtkFileSeriesReader::IgnoreReaderTimeOff ( )

virtual

If true, then treat file series like it does not contain any time step values.

False by default.

◆ FILE_SERIES_NUMBER_OF_FILES()

static vtkInformationIntegerKey* vtkFileSeriesReader::FILE_SERIES_NUMBER_OF_FILES ( )

static

◆ FILE_SERIES_CURRENT_FILE_NUMBER()

static vtkInformationIntegerKey* vtkFileSeriesReader::FILE_SERIES_CURRENT_FILE_NUMBER ( )

static

◆ FILE_SERIES_FIRST_FILENAME()

static vtkInformationStringKey* vtkFileSeriesReader::FILE_SERIES_FIRST_FILENAME ( )

static

◆ GetErrorCode()

unsigned long vtkFileSeriesReader::GetErrorCode ( )

overridevirtual

Return the error code of the reader.

Reimplemented from vtkAlgorithm.

◆ RequestInformation()

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

overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

Reimplemented in vtkExodusFileSeriesReader.

◆ RequestUpdateExtent()

int vtkFileSeriesReader::RequestUpdateExtent	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ RequestUpdateTime()

int vtkFileSeriesReader::RequestUpdateTime	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

inlineoverrideprotected

Definition at line 155 of file vtkFileSeriesReader.h.

◆ RequestUpdateTimeDependentInformation()

virtual int vtkFileSeriesReader::RequestUpdateTimeDependentInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

inlineprotectedvirtual

Reimplemented in vtkAMRFileSeriesReader.

Definition at line 159 of file vtkFileSeriesReader.h.

◆ RequestData()

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

overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ FillOutputPortInformation()

int vtkFileSeriesReader::FillOutputPortInformation	(	int	port,
		vtkInformation *	info
	)

overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ RequestInformationForInput()

virtual int vtkFileSeriesReader::RequestInformationForInput	(	int	index,
		vtkInformation *	request = `nullptr`,
		vtkInformationVector *	outputVector = `nullptr`
	)

protectedvirtual

Make sure the reader's output is set to the given index and, if it changed, run RequestInformation on the reader.

Reimplemented in vtkExodusFileSeriesReader.

◆ ReadMetaDataFile()

virtual int vtkFileSeriesReader::ReadMetaDataFile	(	const char *	metafilename,
		vtkStringArray *	filesToRead,
		std::vector< double > &	timeValues,
		int	maxFilesToRead = `VTK_INT_MAX`
	)

protectedvirtual

Reads a metadata file and returns a list of filenames (in filesToRead).

If the file could not be read correctly, 0 is returned.

◆ UpdateMetaData()

virtual void vtkFileSeriesReader::UpdateMetaData ( )

protectedvirtual

Re-reads information from the metadata file, if necessary.

◆ ResetTimeRanges()

void vtkFileSeriesReader::ResetTimeRanges ( )

protected

Resets information about TimeRanges.

Called in RequestInformation().

◆ RemoveAllFileNamesInternal()

void vtkFileSeriesReader::RemoveAllFileNamesInternal ( )

protected

Add/Remove filenames without changing the MTime.

◆ AddFileNameInternal()

void vtkFileSeriesReader::AddFileNameInternal ( const char * )

protected

◆ RemoveAllRealFileNamesInternal()

virtual void vtkFileSeriesReader::RemoveAllRealFileNamesInternal ( )

protectedvirtual

Remove all real file names.

◆ CopyRealFileNamesFromFileNames()

void vtkFileSeriesReader::CopyRealFileNamesFromFileNames ( )

protected

Set the real filenames to those in the internal FileNames.

◆ ChooseInput()

int vtkFileSeriesReader::ChooseInput ( vtkInformation * )

protected

Member Data Documentation

◆ UseMetaFile

int vtkFileSeriesReader::UseMetaFile

protected

True if use a meta-file, false otherwise.

Definition at line 186 of file vtkFileSeriesReader.h.

◆ UseJsonMetaFile

bool vtkFileSeriesReader::UseJsonMetaFile

protected

True if meta-file is of Json format, false otherwise.

Definition at line 191 of file vtkFileSeriesReader.h.

◆ IgnoreReaderTime

bool vtkFileSeriesReader::IgnoreReaderTime

protected

Definition at line 219 of file vtkFileSeriesReader.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkFileSeriesReader()

◆ ~vtkFileSeriesReader()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ ProcessRequest()

◆ CanReadFile()

◆ AddFileName()

◆ RemoveAllFileNames()

◆ GetNumberOfFileNames()

◆ GetFileName()

◆ GetCurrentFileName()

◆ GetUseMetaFile()

◆ SetUseMetaFile()

◆ UseMetaFileOn()

◆ UseMetaFileOff()

◆ GetIgnoreReaderTime()

◆ SetIgnoreReaderTime()

◆ IgnoreReaderTimeOn()

◆ IgnoreReaderTimeOff()

◆ FILE_SERIES_NUMBER_OF_FILES()

◆ FILE_SERIES_CURRENT_FILE_NUMBER()

◆ FILE_SERIES_FIRST_FILENAME()

◆ GetErrorCode()

◆ RequestInformation()

◆ RequestUpdateExtent()

◆ RequestUpdateTime()

◆ RequestUpdateTimeDependentInformation()

◆ RequestData()

◆ FillOutputPortInformation()

◆ RequestInformationForInput()

◆ ReadMetaDataFile()

◆ UpdateMetaData()

◆ ResetTimeRanges()

◆ RemoveAllFileNamesInternal()

◆ AddFileNameInternal()

◆ RemoveAllRealFileNamesInternal()

◆ CopyRealFileNamesFromFileNames()

◆ ChooseInput()

Member Data Documentation

◆ UseMetaFile

◆ UseJsonMetaFile

◆ IgnoreReaderTime