Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkEnSightGoldReader Class Reference

class to read EnSight Gold files. More...

#include <vtkEnSightGoldReader.h>

Inheritance diagram for vtkEnSightGoldReader:

Inheritance graph
[legend]
Collaboration diagram for vtkEnSightGoldReader:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)

Static Public Methods

vtkEnSightGoldReader * New ()
int IsTypeOf (const char *type)
vtkEnSightGoldReader * SafeDownCast (vtkObject *o)

Protected Methods

 vtkEnSightGoldReader ()
 ~vtkEnSightGoldReader ()
virtual int ReadGeometryFile (char *fileName, int timeStep)
virtual int ReadMeasuredGeometryFile (char *fileName, int timeStep)
virtual int CreateUnstructuredGridOutput (int partId, char line[256])
virtual int CreateStructuredGridOutput (int partId, char line[256])
int CreateRectilinearGridOutput (int partId, char line[256])
int CreateImageDataOutput (int partId, char line[256])
virtual int ReadScalarsPerNode (char *fileName, char *description, int timeStep, int measured=0, int numberOfComponents=1, int component=0)
virtual int ReadVectorsPerNode (char *fileName, char *description, int timeStep, int measured=0)
virtual int ReadTensorsPerNode (char *fileName, char *description, int timeStep)
virtual int ReadScalarsPerElement (char *fileName, char *description, int timeStep, int numberOfComponents=1, int component=0)
virtual int ReadVectorsPerElement (char *fileName, char *description, int timeStep)
virtual int ReadTensorsPerElement (char *fileName, char *description, int timeStep)
virtual void SetGeometryFileName (const char *)
virtual char * GetGeometryFileName ()
virtual void SetMeasuredFileName (const char *)
virtual char * GetMeasuredFileName ()
virtual void SetMatchFileName (const char *)
virtual char * GetMatchFileName ()

Detailed Description

class to read EnSight Gold files.

Date:
2001/11/13 14:30:28
Revision:
1.12

vtkEnSightGoldReader is a class to read EnSight Gold files into vtk. Because the different parts of the EnSight data can be of various data types, this reader produces multiple outputs, one per part in the input file. All variable information is being stored in field data. The descriptions listed in the case file are used as the array names in the field data. For complex vector variables, the description is appended with _r (for the array of real values) and _i (for the array if imaginary values). Complex scalar variables are stored as a single array with 2 components, real and imaginary, listed in that order.

Warning:
You must manually call Update on this reader and then connect the rest of the pipeline because (due to the nature of the file format) it is not possible to know ahead of time how many outputs you will have or what types they will be. This reader can only handle static EnSight datasets (both static geometry and variables).

Definition at line 70 of file vtkEnSightGoldReader.h.

Constructor & Destructor Documentation

vtkEnSightGoldReader::vtkEnSightGoldReader (    )  [inline, protected]
 

Definition at line 77 of file vtkEnSightGoldReader.h.

vtkEnSightGoldReader::~vtkEnSightGoldReader (    )  [inline, protected]
 

Definition at line 78 of file vtkEnSightGoldReader.h.

Member Function Documentation

vtkEnSightGoldReader* vtkEnSightGoldReader::New (    )  [static]
 

Instantiate object with no start, end, or progress methods.

Reimplemented from vtkDataSetSource.

virtual const char* vtkEnSightGoldReader::GetClassName (    )  [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkEnSightReader.

int vtkEnSightGoldReader::IsTypeOf (  const char *    type )  [static]
 

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkEnSightReader.

virtual int vtkEnSightGoldReader::IsA (  const char *    type )  [virtual]
 

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkEnSightReader.

vtkEnSightGoldReader* vtkEnSightGoldReader::SafeDownCast (  vtkObject *    o )  [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkEnSightReader.

virtual int vtkEnSightGoldReader::ReadGeometryFile (  char *    fileName,
int    timeStep
)  [protected, virtual]
 

Read the geometry file. If an error occurred, 0 is returned; otherwise 1.

Reimplemented from vtkEnSightReader.

virtual int vtkEnSightGoldReader::ReadMeasuredGeometryFile (  char *    fileName,
int    timeStep
)  [protected, virtual]
 

Read the measured geometry file. If an error occurred, 0 is returned; otherwise 1.

Reimplemented from vtkEnSightReader.

virtual int vtkEnSightGoldReader::ReadScalarsPerNode (  char *    fileName,
char *    description,
int    timeStep,
int    measured = 0,
int    numberOfComponents = 1,
int    component = 0
)  [protected, virtual]
 

Read scalars per node for this dataset. If an error occurred, 0 is returned; otherwise 1. If there will be more than one component in the data array, it is assumed that 0 is the first component added.

Reimplemented from vtkEnSightReader.

virtual int vtkEnSightGoldReader::ReadVectorsPerNode (  char *    fileName,
char *    description,
int    timeStep,
int    measured = 0
)  [protected, virtual]
 

Read vectors per node for this dataset. If an error occurred, 0 is returned; otherwise 1.

Reimplemented from vtkEnSightReader.

virtual int vtkEnSightGoldReader::ReadTensorsPerNode (  char *    fileName,
char *    description,
int    timeStep
)  [protected, virtual]
 

Read tensors per node for this dataset. If an error occurred, 0 is returned; otherwise 1.

Reimplemented from vtkEnSightReader.

virtual int vtkEnSightGoldReader::ReadScalarsPerElement (  char *    fileName,
char *    description,
int    timeStep,
int    numberOfComponents = 1,
int    component = 0
)  [protected, virtual]
 

Read scalars per element for this dataset. If an error occurred, 0 is returned; otherwise 1. If there will be more than one componenet in the data array, it is assumed that 0 is the first component added.

Reimplemented from vtkEnSightReader.

virtual int vtkEnSightGoldReader::ReadVectorsPerElement (  char *    fileName,
char *    description,
int    timeStep
)  [protected, virtual]
 

Read vectors per element for this dataset. If an error occurred, 0 is returned; otherwise 1.

Reimplemented from vtkEnSightReader.

virtual int vtkEnSightGoldReader::ReadTensorsPerElement (  char *    fileName,
char *    description,
int    timeStep
)  [protected, virtual]
 

Read tensors per element for this dataset. If an error occurred, 0 is returned; otherwise 1.

Reimplemented from vtkEnSightReader.

virtual int vtkEnSightGoldReader::CreateUnstructuredGridOutput (  int    partId,
char    line[256]
)  [protected, virtual]
 

Read an unstructured part (partId) from the geometry file and create a vtkUnstructuredGrid output. Return 0 if EOF reached. Return -1 if an error occurred.

Reimplemented from vtkEnSightReader.

virtual int vtkEnSightGoldReader::CreateStructuredGridOutput (  int    partId,
char    line[256]
)  [protected, virtual]
 

Read a structured part from the geometry file and create a vtkStructuredGrid output. Return 0 if EOF reached.

Reimplemented from vtkEnSightReader.

int vtkEnSightGoldReader::CreateRectilinearGridOutput (  int    partId,
char    line[256]
)  [protected]
 

Read a structured part from the geometry file and create a vtkRectilinearGrid output. Return 0 if EOF reached.

int vtkEnSightGoldReader::CreateImageDataOutput (  int    partId,
char    line[256]
)  [protected]
 

Read a structured part from the geometry file and create a vtkImageData output. Return 0 if EOF reached.

virtual void vtkEnSightGoldReader::SetGeometryFileName (  const char *    )  [protected, virtual]
 

Set/Get the Model file name.

Reimplemented from vtkEnSightReader.

virtual char* vtkEnSightGoldReader::GetGeometryFileName (    )  [protected, virtual]
 

Set/Get the Model file name.

Reimplemented from vtkEnSightReader.

virtual void vtkEnSightGoldReader::SetMeasuredFileName (  const char *    )  [protected, virtual]
 

Set/Get the Measured file name.

Reimplemented from vtkEnSightReader.

virtual char* vtkEnSightGoldReader::GetMeasuredFileName (    )  [protected, virtual]
 

Set/Get the Measured file name.

Reimplemented from vtkEnSightReader.

virtual void vtkEnSightGoldReader::SetMatchFileName (  const char *    )  [protected, virtual]
 

Set/Get the Match file name.

Reimplemented from vtkEnSightReader.

virtual char* vtkEnSightGoldReader::GetMatchFileName (    )  [protected, virtual]
 

Set/Get the Match file name.

Reimplemented from vtkEnSightReader.

The documentation for this class was generated from the following file:
Generated on Thu Mar 28 14:29:09 2002 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001