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

vtkGenericEnSightReader Class Reference

class to read any type of EnSight files. More...

#include <vtkGenericEnSightReader.h>

Inheritance diagram for vtkGenericEnSightReader:

Inheritance graph
[legend]
Collaboration diagram for vtkGenericEnSightReader:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void Update ()
char * GetDescription (int n)
char * GetComplexDescription (int n)
char * GetDescription (int n, int type)
void SetCaseFileName (char *fileName)
virtual char * GetCaseFileName ()
virtual void SetFilePath (const char *)
virtual char * GetFilePath ()
int GetNumberOfVariables (int type)
virtual int GetNumberOfScalarsPerNode ()
virtual int GetNumberOfVectorsPerNode ()
virtual int GetNumberOfTensorsSymmPerNode ()
virtual int GetNumberOfScalarsPerElement ()
virtual int GetNumberOfVectorsPerElement ()
virtual int GetNumberOfTensorsSymmPerElement ()
virtual int GetNumberOfScalarsPerMeasuredNode ()
virtual int GetNumberOfVectorsPerMeasuredNode ()
virtual int GetNumberOfComplexScalarsPerNode ()
virtual int GetNumberOfComplexVectorsPerNode ()
virtual int GetNumberOfComplexScalarsPerElement ()
virtual int GetNumberOfComplexVectorsPerElement ()
int GetVariableType (int n)
int GetComplexVariableType (int n)
virtual void SetTimeValue (float)
virtual float GetTimeValue ()
virtual float GetMinimumTimeValue ()
virtual float GetMaximumTimeValue ()

Static Public Methods

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

Protected Methods

 vtkGenericEnSightReader ()
 ~vtkGenericEnSightReader ()
void Execute ()
int DetermineEnSightVersion ()
int ReadLine (char result[256])
int ReadBinaryLine (char result[80])
int ReadNextDataLine (char result[256])
virtual void SetGeometryFileName (const char *)
virtual char * GetGeometryFileName ()
void AddVariableDescription (char *description)
void AddComplexVariableDescription (char *description)
void AddVariableType (int variableType)
void AddComplexVariableType (int variableType)
void ReplaceWildcards (char *fileName, int timeSet, int fileSet)
void ReplaceWildcardsHelper (char *fileName, int num)

Protected Attributes

istream * IS
FILE * IFile
vtkEnSightReader * Reader
char * CaseFileName
char * GeometryFileName
char * FilePath
int * VariableTypes
int * ComplexVariableTypes
char ** VariableDescriptions
char ** ComplexVariableDescriptions
int NumberOfVariables
int NumberOfComplexVariables
int NumberOfScalarsPerNode
int NumberOfVectorsPerNode
int NumberOfTensorsSymmPerNode
int NumberOfScalarsPerElement
int NumberOfVectorsPerElement
int NumberOfTensorsSymmPerElement
int NumberOfScalarsPerMeasuredNode
int NumberOfVectorsPerMeasuredNode
int NumberOfComplexScalarsPerNode
int NumberOfComplexVectorsPerNode
int NumberOfComplexScalarsPerElement
int NumberOfComplexVectorsPerElement
float TimeValue
float MinimumTimeValue
float MaximumTimeValue

Detailed Description

class to read any type of EnSight files.

Date:
2001/10/11 13:37:30
Revision:
1.10

The class vtkGenericEnSightReader allows the user to read an EnSight data set without a priori knowledge of what type of EnSight data set it is.

Tests:
vtkGenericEnSightReader (Tests)

Definition at line 63 of file vtkGenericEnSightReader.h.

Constructor & Destructor Documentation

vtkGenericEnSightReader::vtkGenericEnSightReader (    )  [protected]
 

vtkGenericEnSightReader::~vtkGenericEnSightReader (    )  [protected]
 

Member Function Documentation

vtkGenericEnSightReader* vtkGenericEnSightReader::New (    )  [static]
 

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

Reimplemented from vtkDataSetSource.

virtual const char* vtkGenericEnSightReader::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 vtkDataSetSource.

int vtkGenericEnSightReader::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 vtkDataSetSource.

virtual int vtkGenericEnSightReader::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 vtkDataSetSource.

vtkGenericEnSightReader* vtkGenericEnSightReader::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 vtkDataSetSource.

void vtkGenericEnSightReader::PrintSelf (  ostream &    os,
vtkIndent    indent
)  [virtual]
 

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkSource.

void vtkGenericEnSightReader::SetCaseFileName (  char *    fileName ) 
 

Set/Get the Case file name.

virtual char* vtkGenericEnSightReader::GetCaseFileName (    )  [virtual]
 

Set/Get the Case file name.

virtual void vtkGenericEnSightReader::SetFilePath (  const char *    )  [virtual]
 

Set/Get the file path.

virtual char* vtkGenericEnSightReader::GetFilePath (    )  [virtual]
 

Set/Get the file path.

void vtkGenericEnSightReader::Update (    )  [virtual]
 

Bring object up-to-date before execution. Update() checks modified time against last execution time, and re-executes object if necessary.

Reimplemented from vtkSource.

int vtkGenericEnSightReader::GetNumberOfVariables (  int    type ) 
 

Get the number of variables of a particular type.

virtual int vtkGenericEnSightReader::GetNumberOfScalarsPerNode (    )  [virtual]
 

Get the number of variables of a particular type.

virtual int vtkGenericEnSightReader::GetNumberOfVectorsPerNode (    )  [virtual]
 

Get the number of variables of a particular type.

virtual int vtkGenericEnSightReader::GetNumberOfTensorsSymmPerNode (    )  [virtual]
 

Get the number of variables of a particular type.

virtual int vtkGenericEnSightReader::GetNumberOfScalarsPerElement (    )  [virtual]
 

Get the number of variables of a particular type.

virtual int vtkGenericEnSightReader::GetNumberOfVectorsPerElement (    )  [virtual]
 

Get the number of variables of a particular type.

virtual int vtkGenericEnSightReader::GetNumberOfTensorsSymmPerElement (    )  [virtual]
 

Get the number of variables of a particular type.

virtual int vtkGenericEnSightReader::GetNumberOfScalarsPerMeasuredNode (    )  [virtual]
 

Get the number of variables of a particular type.

virtual int vtkGenericEnSightReader::GetNumberOfVectorsPerMeasuredNode (    )  [virtual]
 

Get the number of variables of a particular type.

virtual int vtkGenericEnSightReader::GetNumberOfComplexScalarsPerNode (    )  [virtual]
 

Get the number of variables of a particular type.

virtual int vtkGenericEnSightReader::GetNumberOfComplexVectorsPerNode (    )  [virtual]
 

Get the number of variables of a particular type.

virtual int vtkGenericEnSightReader::GetNumberOfComplexScalarsPerElement (    )  [virtual]
 

Get the number of variables of a particular type.

virtual int vtkGenericEnSightReader::GetNumberOfComplexVectorsPerElement (    )  [virtual]
 

Get the number of variables of a particular type.

char* vtkGenericEnSightReader::GetDescription (  int    n ) 
 

Get the nth description for a non-complex variable.

char* vtkGenericEnSightReader::GetComplexDescription (  int    n ) 
 

Get the nth description for a complex variable.

char* vtkGenericEnSightReader::GetDescription (  int    n,
int    type
) 
 

Get the nth description of a particular variable type. Returns NULL if no variable of this type exists in this data set. VTK_SCALAR_PER_NODE = 0; VTK_VECTOR_PER_NODE = 1; VTK_TENSOR_SYMM_PER_NODE = 2; VTK_SCALAR_PER_ELEMENT = 3; VTK_VECTOR_PER_ELEMENT = 4; VTK_TENSOR_SYMM_PER_ELEMENT = 5; VTK_SCALAR_PER_MEASURED_NODE = 6; VTK_VECTOR_PER_MEASURED_NODE = 7; VTK_COMPLEX_SCALAR_PER_NODE = 8; VTK_COMPLEX_VECTOR_PER_NODE 9; VTK_COMPLEX_SCALAR_PER_ELEMENT = 10; VTK_COMPLEX_VECTOR_PER_ELEMENT = 11

int vtkGenericEnSightReader::GetVariableType (  int    n ) 
 

Get the variable type of variable n.

int vtkGenericEnSightReader::GetComplexVariableType (  int    n ) 
 

Get the variable type of variable n.

virtual void vtkGenericEnSightReader::SetTimeValue (  float    )  [virtual]
 

Set/Get the time value at which to get the value.

virtual float vtkGenericEnSightReader::GetTimeValue (    )  [virtual]
 

Set/Get the time value at which to get the value.

virtual float vtkGenericEnSightReader::GetMinimumTimeValue (    )  [virtual]
 

Get the minimum or maximum time value for this data set.

virtual float vtkGenericEnSightReader::GetMaximumTimeValue (    )  [virtual]
 

Get the minimum or maximum time value for this data set.

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

This method is the old style execute method

Reimplemented from vtkSource.

int vtkGenericEnSightReader::DetermineEnSightVersion (    )  [protected]
 

Reads the FORMAT part of the case file to determine whether this is an EnSight6 or EnSightGold data set. Returns 0 if the format is EnSight6, 1 if it is EnSightGold, and -1 otherwise (meaning an error occurred).

int vtkGenericEnSightReader::ReadLine (  char    result[256] )  [protected]
 

Internal function to read in a line up to 256 characters. Returns zero if there was an error.

int vtkGenericEnSightReader::ReadBinaryLine (  char    result[80] )  [protected]
 

Internal function to read up to 80 characters from a binary file. Returns zero if there was an error.

int vtkGenericEnSightReader::ReadNextDataLine (  char    result[256] )  [protected]
 

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

Set/Get the geometry file name.

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

Set/Get the geometry file name.

void vtkGenericEnSightReader::AddVariableDescription (  char *    description )  [protected]
 

Add a variable description to the appropriate array.

void vtkGenericEnSightReader::AddComplexVariableDescription (  char *    description )  [protected]
 

Add a variable description to the appropriate array.

void vtkGenericEnSightReader::AddVariableType (  int    variableType )  [protected]
 

Add a variable type to the appropriate array.

void vtkGenericEnSightReader::AddComplexVariableType (  int    variableType )  [protected]
 

Add a variable type to the appropriate array.

void vtkGenericEnSightReader::ReplaceWildcards (  char *    fileName,
int    timeSet,
int    fileSet
)  [protected]
 

Replace the wildcards in the geometry file name with appropriate filename numbers as specified in the time set or file set.

void vtkGenericEnSightReader::ReplaceWildcardsHelper (  char *    fileName,
int    num
)  [protected]
 

Replace the wildcards in the geometry file name with appropriate filename numbers as specified in the time set or file set.

Member Data Documentation

istream* vtkGenericEnSightReader::IS [protected]
 

Definition at line 186 of file vtkGenericEnSightReader.h.

FILE* vtkGenericEnSightReader::IFile [protected]
 

Definition at line 187 of file vtkGenericEnSightReader.h.

vtkEnSightReader* vtkGenericEnSightReader::Reader [protected]
 

Definition at line 188 of file vtkGenericEnSightReader.h.

char* vtkGenericEnSightReader::CaseFileName [protected]
 

Definition at line 190 of file vtkGenericEnSightReader.h.

char* vtkGenericEnSightReader::GeometryFileName [protected]
 

Definition at line 191 of file vtkGenericEnSightReader.h.

char* vtkGenericEnSightReader::FilePath [protected]
 

Definition at line 192 of file vtkGenericEnSightReader.h.

int* vtkGenericEnSightReader::VariableTypes [protected]
 

Definition at line 194 of file vtkGenericEnSightReader.h.

int* vtkGenericEnSightReader::ComplexVariableTypes [protected]
 

Definition at line 195 of file vtkGenericEnSightReader.h.

char** vtkGenericEnSightReader::VariableDescriptions [protected]
 

Definition at line 197 of file vtkGenericEnSightReader.h.

char** vtkGenericEnSightReader::ComplexVariableDescriptions [protected]
 

Definition at line 198 of file vtkGenericEnSightReader.h.

int vtkGenericEnSightReader::NumberOfVariables [protected]
 

Definition at line 200 of file vtkGenericEnSightReader.h.

int vtkGenericEnSightReader::NumberOfComplexVariables [protected]
 

Definition at line 201 of file vtkGenericEnSightReader.h.

int vtkGenericEnSightReader::NumberOfScalarsPerNode [protected]
 

Definition at line 204 of file vtkGenericEnSightReader.h.

int vtkGenericEnSightReader::NumberOfVectorsPerNode [protected]
 

Definition at line 205 of file vtkGenericEnSightReader.h.

int vtkGenericEnSightReader::NumberOfTensorsSymmPerNode [protected]
 

Definition at line 206 of file vtkGenericEnSightReader.h.

int vtkGenericEnSightReader::NumberOfScalarsPerElement [protected]
 

Definition at line 207 of file vtkGenericEnSightReader.h.

int vtkGenericEnSightReader::NumberOfVectorsPerElement [protected]
 

Definition at line 208 of file vtkGenericEnSightReader.h.

int vtkGenericEnSightReader::NumberOfTensorsSymmPerElement [protected]
 

Definition at line 209 of file vtkGenericEnSightReader.h.

int vtkGenericEnSightReader::NumberOfScalarsPerMeasuredNode [protected]
 

Definition at line 210 of file vtkGenericEnSightReader.h.

int vtkGenericEnSightReader::NumberOfVectorsPerMeasuredNode [protected]
 

Definition at line 211 of file vtkGenericEnSightReader.h.

int vtkGenericEnSightReader::NumberOfComplexScalarsPerNode [protected]
 

Definition at line 212 of file vtkGenericEnSightReader.h.

int vtkGenericEnSightReader::NumberOfComplexVectorsPerNode [protected]
 

Definition at line 213 of file vtkGenericEnSightReader.h.

int vtkGenericEnSightReader::NumberOfComplexScalarsPerElement [protected]
 

Definition at line 214 of file vtkGenericEnSightReader.h.

int vtkGenericEnSightReader::NumberOfComplexVectorsPerElement [protected]
 

Definition at line 215 of file vtkGenericEnSightReader.h.

float vtkGenericEnSightReader::TimeValue [protected]
 

Definition at line 217 of file vtkGenericEnSightReader.h.

float vtkGenericEnSightReader::MinimumTimeValue [protected]
 

Definition at line 218 of file vtkGenericEnSightReader.h.

float vtkGenericEnSightReader::MaximumTimeValue [protected]
 

Definition at line 219 of file vtkGenericEnSightReader.h.

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