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

meta-reader to read file series More...

#include <vtkFileSeriesReader.h>

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

Public Types

typedef vtkMetaReader Superclass
 
- Public Types inherited from vtkMetaReader
typedef vtkDataObjectAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 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 ()
 
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 int GetIgnoreReaderTime ()
 If true, then treat file series like it does not contain any time step values. More...
 
virtual void SetIgnoreReaderTime (int)
 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 ()
 
virtual vtkMTimeType GetMTime ()
 Return the MTime when also considering the internal reader. More...
 
void PrintSelf (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkFileSeriesReaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkFileSeriesReaderSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMetaReader
static vtkMetaReaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkMetaReaderSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkFileSeriesReader ()
 
 ~vtkFileSeriesReader ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestUpdateTimeDependentInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int RequestInformationForInput (int index, vtkInformation *request=NULL, vtkInformationVector *outputVector=NULL)
 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, 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 ()
 
void AddFileNameInternal (const char *)
 
int ChooseInput (vtkInformation *)
 
- Protected Member Functions inherited from vtkMetaReader
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 Attributes

int UseMetaFile
 True if use a meta-file, false otherwise. More...
 
int 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...
 

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 two 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 a single "meta" file. This meta file 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 toggles between these two methods of specifying files.

Definition at line 60 of file vtkFileSeriesReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 64 of file vtkFileSeriesReader.h.

Constructor & Destructor Documentation

◆ vtkFileSeriesReader()

vtkFileSeriesReader::vtkFileSeriesReader ( )
protected

◆ ~vtkFileSeriesReader()

vtkFileSeriesReader::~vtkFileSeriesReader ( )
protected

Member Function Documentation

◆ New()

static vtkFileSeriesReader* vtkFileSeriesReader::New ( )
static

◆ GetClassName()

virtual const char* vtkFileSeriesReader::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ ProcessRequest()

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

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

◆ RequestInformation()

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

◆ RequestUpdateExtent()

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

◆ RequestUpdateTime()

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

Reimplemented in vtkAMRFileSeriesReader.

Definition at line 130 of file vtkFileSeriesReader.h.

◆ RequestUpdateTimeDependentInformation()

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

Reimplemented in vtkAMRFileSeriesReader.

Definition at line 134 of file vtkFileSeriesReader.h.

◆ RequestData()

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

◆ FillOutputPortInformation()

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

Reimplemented from vtkMetaReader.

◆ RequestInformationForInput()

virtual int vtkFileSeriesReader::RequestInformationForInput ( int  index,
vtkInformation *  request = NULL,
vtkInformationVector *  outputVector = NULL 
)
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,
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

◆ AddFileNameInternal()

void vtkFileSeriesReader::AddFileNameInternal ( const char *  )
protected

◆ 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 161 of file vtkFileSeriesReader.h.

◆ IgnoreReaderTime

int vtkFileSeriesReader::IgnoreReaderTime
protected

Definition at line 177 of file vtkFileSeriesReader.h.


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