vtkInputSource Class Reference

#include <vtkInputSource.h>

Inheritance diagram for vtkInputSource:

[legend]Collaboration diagram for vtkInputSource:

[legend]List of all members.

---

Detailed Description

Source object for reading an input DataSet from data files.

Author:

Sean McInerney

Version:

Revision

1.3

Date:

Date

2004/08/10 07:37:23

Definition at line 41 of file vtkInputSource.h.

[NOHEADER]
const char *	ReadOutputTypeAsString (void)
const char *	GetDataObjectTypeAsString (int type)
	Return the data object type as a string.
Public Member Functions
	vtkTypeRevisionMacro (vtkInputSource, vtkSource)
void	PrintSelf (ostream &, vtkIndent)
bool	CanReadFile (const char *fileName)
	Return readability of given filename (as a non-directory).
bool	CanReadFile (int index)
	Return readability of given index (applied with FilePrefix/FilePattern).
bool	CanReadFiles (void)
	Return readability of any and all input file(s).
vtkPolyData *	GetPolyDataOutput (void)
	Get the output as vtkPolyData.
vtkStructuredPoints *	GetStructuredPointsOutput (void)
	Get the output as vtkStructuredPoints.
vtkStructuredGrid *	GetStructuredGridOutput (void)
	Get the output as vtkStructuredGrid.
vtkUnstructuredGrid *	GetUnstructuredGridOutput (void)
	Get the output as vtkUnstructuredGrid.
vtkRectilinearGrid *	GetRectilinearGridOutput (void)
	Get the output as vtkRectilinearGrid.
void	Update (void)
	If there is no output, execute anyway.
int	ReadOutputType (void)
	This method can be used to find out the type of output expected without needing to read the whole file.
vtkSource *	GetReader (void)
virtual void	SetReader (vtkSource *)
int	GetFileType (void) const
	Specify file type of vtk data file to read.
void	SetFileType (int type)
	Specify file type of vtk data file to read.
const char *	GetFileName (void) const
	Specify file name for the data file to be read.
void	SetFileName (const char *name)
	Specify file name for the data file to be read.
const char *	GetFilePrefix (void) const
	Specify file prefix for the data file(s) to be read.
void	SetFilePrefix (const char *prefix)
	Specify file prefix for the data file(s) to be read.
const char *	GetFilePattern (void) const
	The sprintf format used to build filename from FilePrefix and number.
void	SetFilePattern (const char *pattern)
	The sprintf format used to build filename from FilePrefix and number.
int	GetFileDimensionality (void) const
	The number of dimensions stored in the data file.
void	SetFileDimensionality (int dimensionality=2)
	The number of dimensions stored in the data file.
int	GetFileIndexCount (void) const
	The total number of files to be read.
void	SetFileIndexCount (int count=1)
	The total number of files to be read.
int	GetFileIndexOffset (void) const
	When reading files which start at an unusual index, this can be added to the index number when generating the file name (default = 0).
void	SetFileIndexOffset (int offset=0)
	When reading files which start at an unusual index, this can be added to the index number when generating the file name (default = 0).
int	GetFileIndexSpacing (void) const
	When reading files which have regular, but non contiguous index numbers (e.g.
void	SetFileIndexSpacing (int spacing=1)
	When reading files which have regular, but non contiguous index numbers (e.g.
vtkDataSet *	GetOutput (void)
	Get the output of this source.
vtkDataSet *	GetOutput (int index)
	Get the output of this source.
Static Public Member Functions
vtkInputSource *	New (void)
Protected Member Functions
	vtkInputSource (void)
	~vtkInputSource ()
void	SetOutput (vtkDataObject *)
void	Execute (void)
Protected Attributes
vtkSource *	Reader

---

Constructor & Destructor Documentation

vtkInputSource::vtkInputSource (  void   )  [protected]

vtkInputSource::~vtkInputSource (   )  [protected]

---

Member Function Documentation

bool vtkInputSource::CanReadFile (  int  index  )

Return readability of given index (applied with FilePrefix/FilePattern).

bool vtkInputSource::CanReadFile (  const char *  fileName  )

Return readability of given filename (as a non-directory).

bool vtkInputSource::CanReadFiles (  void   )

Return readability of any and all input file(s).

void vtkInputSource::Execute (  void   )  [protected, virtual]

Reimplemented from vtkSource.

const char * vtkInputSource::GetDataObjectTypeAsString (  int  type  )  [inline, static]

Return the data object type as a string. Definition at line 183 of file vtkInputSource.h. References GetDataObjectTypeAsString(), VTK_DATA_OBJECT, VTK_DATA_SET, VTK_IMAGE_DATA, VTK_PIECEWISE_FUNCTION, VTK_POINT_SET, VTK_POLY_DATA, VTK_RECTILINEAR_GRID, VTK_STRUCTURED_GRID, VTK_STRUCTURED_POINTS, and VTK_UNSTRUCTURED_GRID. Referenced by GetDataObjectTypeAsString(), and ReadOutputTypeAsString().

int vtkInputSource::GetFileDimensionality (  void   )  const

The number of dimensions stored in the data file.

int vtkInputSource::GetFileIndexCount (  void   )  const

The total number of files to be read.

int vtkInputSource::GetFileIndexOffset (  void   )  const

When reading files which start at an unusual index, this can be added to the index number when generating the file name (default = 0).

int vtkInputSource::GetFileIndexSpacing (  void   )  const

When reading files which have regular, but non contiguous index numbers (e.g. filename.1, filename.3, filename.5) a spacing can be specified to skip missing files (default = 1).

const char* vtkInputSource::GetFileName (  void   )  const

Specify file name for the data file to be read. You should specify either a FileName or a FilePrefix. Use FilePrefix if the data are stored in multiple files.

const char* vtkInputSource::GetFilePattern (  void   )  const

The sprintf format used to build filename from FilePrefix and number.

const char* vtkInputSource::GetFilePrefix (  void   )  const

Specify file prefix for the data file(s) to be read. You should specify either a FileName or FilePrefix. Use FilePrefix if the data are stored in multiple files.

int vtkInputSource::GetFileType (  void   )  const

Specify file type of vtk data file to read.

vtkDataSet* vtkInputSource::GetOutput (  int  index  )

Get the output of this source. If output is NULL then input hasn't been set which is necessary for abstract objects. Reimplemented from vtkSource.

vtkDataSet* vtkInputSource::GetOutput (  void   )

Get the output of this source. If output is NULL then input hasn't been set which is necessary for abstract objects.

vtkPolyData* vtkInputSource::GetPolyDataOutput (  void   )

Get the output as vtkPolyData.

vtkSource* vtkInputSource::GetReader (  void   )

vtkRectilinearGrid* vtkInputSource::GetRectilinearGridOutput (  void   )

Get the output as vtkRectilinearGrid.

vtkStructuredGrid* vtkInputSource::GetStructuredGridOutput (  void   )

Get the output as vtkStructuredGrid.

vtkStructuredPoints* vtkInputSource::GetStructuredPointsOutput (  void   )

Get the output as vtkStructuredPoints.

vtkUnstructuredGrid* vtkInputSource::GetUnstructuredGridOutput (  void   )

Get the output as vtkUnstructuredGrid.

vtkInputSource* vtkInputSource::New (  void   )  [static]

Reimplemented from vtkObject.

void vtkInputSource::PrintSelf (  ostream &  , vtkIndent  )  [virtual]

Reimplemented from vtkSource.

int vtkInputSource::ReadOutputType (  void   )

This method can be used to find out the type of output expected without needing to read the whole file.

const char * vtkInputSource::ReadOutputTypeAsString (  void   )  [inline]

Definition at line 203 of file vtkInputSource.h. References GetDataObjectTypeAsString().

void vtkInputSource::SetFileDimensionality (  int  dimensionality = 2  )

The number of dimensions stored in the data file.

void vtkInputSource::SetFileIndexCount (  int  count = 1  )

The total number of files to be read.

void vtkInputSource::SetFileIndexOffset (  int  offset = 0  )

When reading files which start at an unusual index, this can be added to the index number when generating the file name (default = 0).

void vtkInputSource::SetFileIndexSpacing (  int  spacing = 1  )

When reading files which have regular, but non contiguous index numbers (e.g. filename.1, filename.3, filename.5) a spacing can be specified to skip missing files (default = 1).

void vtkInputSource::SetFileName (  const char *  name  )

Specify file name for the data file to be read. You should specify either a FileName or a FilePrefix. Use FilePrefix if the data are stored in multiple files.

void vtkInputSource::SetFilePattern (  const char *  pattern  )

The sprintf format used to build filename from FilePrefix and number.

void vtkInputSource::SetFilePrefix (  const char *  prefix  )

Specify file prefix for the data file(s) to be read. You should specify either a FileName or FilePrefix. Use FilePrefix if the data are stored in multiple files.

void vtkInputSource::SetFileType (  int  type  )

Specify file type of vtk data file to read.

void vtkInputSource::SetOutput (  vtkDataObject *   )  [protected]

virtual void vtkInputSource::SetReader (  vtkSource *   )  [virtual]

void vtkInputSource::Update (  void   )  [virtual]

If there is no output, execute anyway. Execute creates an output. Reimplemented from vtkSource.

vtkInputSource::vtkTypeRevisionMacro (  vtkInputSource  , vtkSource  )

---

Member Data Documentation

vtkSource* vtkInputSource::Reader [protected]

Definition at line 170 of file vtkInputSource.h.

---

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

• vtkInputSource.h

---