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

Common functionality for meta-readers. More...

#include <vtkMetaReader.h>

Inheritance diagram for vtkMetaReader:
Inheritance graph
[legend]

Public Types

typedef vtkDataObjectAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
 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 vtkMetaReaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkMetaReaderSafeDownCast (vtkObject *o)
 

Protected Member Functions

virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
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

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

Common functionality for meta-readers.

to another Reader. The Reader reads from a file selected from a list of files using a FileIndex.

Definition at line 33 of file vtkMetaReader.h.

Member Typedef Documentation

§ Superclass

typedef vtkDataObjectAlgorithm vtkMetaReader::Superclass

Definition at line 37 of file vtkMetaReader.h.

Constructor & Destructor Documentation

§ vtkMetaReader()

vtkMetaReader::vtkMetaReader ( )

§ ~vtkMetaReader()

vtkMetaReader::~vtkMetaReader ( )

Member Function Documentation

§ New()

static vtkMetaReader* vtkMetaReader::New ( )
static

§ GetClassName()

virtual const char* vtkMetaReader::GetClassName ( )
virtual

§ IsTypeOf()

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

§ IsA()

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

§ SafeDownCast()

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

§ SetReader()

virtual void vtkMetaReader::SetReader ( vtkAlgorithm *  )
virtual

Set/get the internal reader.

§ GetReader()

virtual vtkAlgorithm* vtkMetaReader::GetReader ( )
virtual

Set/get the internal reader.

§ SetMetaFileName()

void vtkMetaReader::SetMetaFileName ( const char *  name)
inline

Get/set the filename for the meta-file.

Description: Get/Set the meta-file name

Definition at line 56 of file vtkMetaReader.h.

§ GetMetaFileName()

char* vtkMetaReader::GetMetaFileName ( )
inline

Get/set the filename for the meta-file.

Description: Get/Set the meta-file name

Definition at line 61 of file vtkMetaReader.h.

§ GetFileIndexRange() [1/3]

virtual vtkIdType* vtkMetaReader::GetFileIndexRange ( )
virtual

Returns the available range of file indexes.

It is 0, ..., GetNumberOfFiles () - 1.

§ GetFileIndexRange() [2/3]

virtual void vtkMetaReader::GetFileIndexRange ( vtkIdType &  ,
vtkIdType &   
)
virtual

Returns the available range of file indexes.

It is 0, ..., GetNumberOfFiles () - 1.

§ GetFileIndexRange() [3/3]

virtual void vtkMetaReader::GetFileIndexRange ( vtkIdType  [2])
virtual

Returns the available range of file indexes.

It is 0, ..., GetNumberOfFiles () - 1.

§ GetFileIndex()

vtkIdType vtkMetaReader::GetFileIndex ( )
inline

Get/set the index of the file to read.

Definition at line 76 of file vtkMetaReader.h.

§ SetFileIndex()

void vtkMetaReader::SetFileIndex ( vtkIdType  i)
inline

Get/set the index of the file to read.

Definition at line 77 of file vtkMetaReader.h.

§ GetMTime()

virtual vtkMTimeType vtkMetaReader::GetMTime ( )
virtual

Return the MTime when also considering the internal reader.

§ SetFileNameMethod()

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

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

By default, this is SetFileName.

§ GetFileNameMethod()

virtual char* vtkMetaReader::GetFileNameMethod ( )
virtual

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

By default, this is SetFileName.

§ PrintSelf()

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

§ FillOutputPortInformation()

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

Reimplemented in vtkFileSeriesReader.

§ Set_MetaFileName()

virtual void vtkMetaReader::Set_MetaFileName ( const char *  )
protectedvirtual

§ Get_MetaFileName()

virtual char* vtkMetaReader::Get_MetaFileName ( )
protectedvirtual

§ Set_FileIndex()

virtual void vtkMetaReader::Set_FileIndex ( vtkIdType  )
protectedvirtual

§ Get_FileIndex()

virtual vtkIdType vtkMetaReader::Get_FileIndex ( )
protectedvirtual

§ ReaderSetFileName()

void vtkMetaReader::ReaderSetFileName ( const char *  filename)
protected

§ ReaderCanReadFile()

int vtkMetaReader::ReaderCanReadFile ( const char *  filename)
protected

§ FromRelativeToMetaFile()

std::string vtkMetaReader::FromRelativeToMetaFile ( const char *  metaFileName,
const char *  fileName 
)
protected

'metaFileName' to either a file path that is relative to the current working directory (CWD) or to an absolute file path.

The choice is made based on if 'metaFileName' is relative or absolute. Return the original if 'fileName' is already absolute.

Member Data Documentation

§ Reader

vtkAlgorithm* vtkMetaReader::Reader
protected

Definition at line 122 of file vtkMetaReader.h.

§ FileNameMTime

vtkMTimeType vtkMetaReader::FileNameMTime
protected

Definition at line 125 of file vtkMetaReader.h.

§ BeforeFileNameMTime

vtkMTimeType vtkMetaReader::BeforeFileNameMTime
protected

Definition at line 128 of file vtkMetaReader.h.

§ FileNameMethod

char* vtkMetaReader::FileNameMethod
protected

Definition at line 130 of file vtkMetaReader.h.

§ _FileIndex

vtkIdType vtkMetaReader::_FileIndex
protected

Definition at line 132 of file vtkMetaReader.h.

§ FileIndexMTime

vtkMTimeType vtkMetaReader::FileIndexMTime
protected

Definition at line 133 of file vtkMetaReader.h.

§ FileIndexRange

vtkIdType vtkMetaReader::FileIndexRange[2]
protected

Definition at line 135 of file vtkMetaReader.h.

§ _MetaFileName

char* vtkMetaReader::_MetaFileName
protected

Definition at line 138 of file vtkMetaReader.h.

§ MetaFileNameMTime

vtkMTimeType vtkMetaReader::MetaFileNameMTime
protected

Definition at line 140 of file vtkMetaReader.h.

§ MetaFileReadTime

vtkTimeStamp vtkMetaReader::MetaFileReadTime
protected

Records the time when the meta-file was read.

Definition at line 145 of file vtkMetaReader.h.


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