Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkEnSightReader Class Reference

#include <vtkEnSightReader.h>

Inheritance diagram for vtkEnSightReader:

Inheritance graph
[legend]
Collaboration diagram for vtkEnSightReader:

Collaboration graph
[legend]
List of all members.

Detailed Description

superclass for EnSight file readers

Definition at line 28 of file vtkEnSightReader.h.

Public Types

typedef vtkGenericEnSightReader Superclass
enum  ElementTypesList {
  POINT = 0, BAR2 = 1, BAR3 = 2, NSIDED = 3,
  TRIA3 = 4, TRIA6 = 5, QUAD4 = 6, QUAD8 = 7,
  TETRA4 = 8, TETRA10 = 9, PYRAMID5 = 10, PYRAMID13 = 11,
  HEXA8 = 12, HEXA20 = 13, PENTA6 = 14, PENTA15 = 15
}
enum  VariableTypesList {
  SCALAR_PER_NODE = 0, VECTOR_PER_NODE = 1, TENSOR_SYMM_PER_NODE = 2, SCALAR_PER_ELEMENT = 3,
  VECTOR_PER_ELEMENT = 4, TENSOR_SYMM_PER_ELEMENT = 5, SCALAR_PER_MEASURED_NODE = 6, VECTOR_PER_MEASURED_NODE = 7,
  COMPLEX_SCALAR_PER_NODE = 8, COMPLEX_VECTOR_PER_NODE = 9, COMPLEX_SCALAR_PER_ELEMENT = 10, COMPLEX_VECTOR_PER_ELEMENT = 11
}
enum  SectionTypeList { COORDINATES = 0, BLOCK = 1, ELEMENT = 2 }

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void Update ()
void ExecuteInformation ()
void ReplaceNthOutput (int n, vtkDataObject *output)
virtual int GetOutputsAreValid ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkEnSightReader * SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkEnSightReader ()
 ~vtkEnSightReader ()
void Execute ()
int ReadCaseFile ()
virtual int ReadGeometryFile (const char *fileName, int timeStep)=0
virtual int ReadMeasuredGeometryFile (const char *fileName, int timeStep)=0
void AddVariableFileName (const char *fileName1, const char *fileName2=NULL)
void AddVariableDescription (const char *description)
void AddVariableType ()
int GetElementType (const char *line)
int GetSectionType (const char *line)
void ReplaceWildcards (char *filename, int num)
vtkIdList * GetCellIds (int index, int cellType)
virtual void SetUseTimeSets (int)
virtual int GetUseTimeSets ()
virtual void UseTimeSetsOn ()
virtual void UseTimeSetsOff ()
virtual void SetUseFileSets (int)
virtual int GetUseFileSets ()
virtual void UseFileSetsOn ()
virtual void UseFileSetsOff ()
void SetNumberOfOutputsInternal (int num)
int CheckOutputConsistency ()
int ReadVariableFiles ()
virtual int ReadScalarsPerNode (const char *fileName, const char *description, int timeStep, int measured=0, int numberOfComponents=1, int component=0)=0
virtual int ReadVectorsPerNode (const char *fileName, const char *description, int timeStep, int measured=0)=0
virtual int ReadTensorsPerNode (const char *fileName, const char *description, int timeStep)=0
virtual int ReadScalarsPerElement (const char *fileName, const char *description, int timeStep, int numberOfComponents=1, int component=0)=0
virtual int ReadVectorsPerElement (const char *fileName, const char *description, int timeStep)=0
virtual int ReadTensorsPerElement (const char *fileName, const char *description, int timeStep)=0
virtual int CreateUnstructuredGridOutput (int partId, char line[80], const char *name)=0
virtual int CreateStructuredGridOutput (int partId, char line[80], const char *name)=0
virtual void SetGeometryFileName (const char *)
virtual char * GetGeometryFileName ()
virtual void SetMeasuredFileName (const char *)
virtual char * GetMeasuredFileName ()
virtual void SetMatchFileName (const char *)
virtual char * GetMatchFileName ()

Protected Attributes

int CaseFileRead
char * MeasuredFileName
char * MatchFileName
vtkEnSightReaderCellIdsType * CellIds
vtkIdList * UnstructuredPartIds
int VariableMode
char ** VariableFileNames
char ** ComplexVariableFileNames
vtkIdList * VariableTimeSetIds
vtkIdList * ComplexVariableTimeSetIds
vtkIdList * VariableFileSetIds
vtkIdList * ComplexVariableFileSetIds
vtkIdListCollection * TimeSetFileNameNumbers
vtkIdList * TimeSetsWithFilenameNumbers
vtkIdListCollection * FileSetFileNameNumbers
vtkIdList * FileSetsWithFilenameNumbers
vtkIdListCollection * FileSetNumberOfSteps
vtkIdList * TimeSetIds
vtkIdList * FileSets
int GeometryTimeSet
int GeometryFileSet
int MeasuredTimeSet
int MeasuredFileSet
float GeometryTimeValue
float MeasuredTimeValue
int UseTimeSets
int UseFileSets
int NumberOfGeometryParts
int NumberOfMeasuredPoints
int NumberOfNewOutputs
int OutputsAreValid
int InitialRead

Member Typedef Documentation

typedef vtkGenericEnSightReader vtkEnSightReader::Superclass
 

Reimplemented from vtkGenericEnSightReader.

Reimplemented in vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, and vtkEnSightGoldReader.

Definition at line 31 of file vtkEnSightReader.h.

Member Enumeration Documentation

enum vtkEnSightReader::ElementTypesList
 

Enumerator:
POINT 
BAR2 
BAR3 
NSIDED 
TRIA3 
TRIA6 
QUAD4 
QUAD8 
TETRA4 
TETRA10 
PYRAMID5 
PYRAMID13 
HEXA8 
HEXA20 
PENTA6 
PENTA15 

Definition at line 38 of file vtkEnSightReader.h.

enum vtkEnSightReader::VariableTypesList
 

Enumerator:
SCALAR_PER_NODE 
VECTOR_PER_NODE 
TENSOR_SYMM_PER_NODE 
SCALAR_PER_ELEMENT 
VECTOR_PER_ELEMENT 
TENSOR_SYMM_PER_ELEMENT 
SCALAR_PER_MEASURED_NODE 
VECTOR_PER_MEASURED_NODE 
COMPLEX_SCALAR_PER_NODE 
COMPLEX_VECTOR_PER_NODE 
COMPLEX_SCALAR_PER_ELEMENT 
COMPLEX_VECTOR_PER_ELEMENT 

Definition at line 58 of file vtkEnSightReader.h.

enum vtkEnSightReader::SectionTypeList
 

Enumerator:
COORDINATES 
BLOCK 
ELEMENT 

Definition at line 74 of file vtkEnSightReader.h.

Constructor & Destructor Documentation

vtkEnSightReader::vtkEnSightReader (   )  [protected]
 

vtkEnSightReader::~vtkEnSightReader (   )  [protected]
 

Member Function Documentation

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

Reimplemented from vtkGenericEnSightReader.

Reimplemented in vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, and vtkEnSightGoldReader.

static int vtkEnSightReader::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkGenericEnSightReader.

Reimplemented in vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, and vtkEnSightGoldReader.

virtual int vtkEnSightReader::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkGenericEnSightReader.

Reimplemented in vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, and vtkEnSightGoldReader.

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

Reimplemented from vtkGenericEnSightReader.

Reimplemented in vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, and vtkEnSightGoldReader.

void vtkEnSightReader::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 vtkGenericEnSightReader.

Reimplemented in vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, and vtkEnSightGoldReader.

void vtkEnSightReader::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 vtkGenericEnSightReader.

void vtkEnSightReader::ExecuteInformation (   )  [virtual]
 

Reimplemented from vtkGenericEnSightReader.

void vtkEnSightReader::ReplaceNthOutput (  int  n,
vtkDataObject *  output
) 
 

This method sets/replaces one of the outputs of the reader without changing it's modification time. Make sure that you pass the right type of data object.

virtual int vtkEnSightReader::GetOutputsAreValid (   )  [virtual]
 

OutputsAreValid indicates whether the outputs from this reader have changed in a consistent way. If during re-reading (because of a change in time step or data set) the number of outputs becomes less than the current number or the type of a particular output changes (e.g., from vtkUnstructuredGrid to vtkImageData), then this flag is set to 0. Otherwise it is set to 1.

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

This method is the old style execute method

Reimplemented from vtkGenericEnSightReader.

int vtkEnSightReader::ReadCaseFile (   )  [protected]
 

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

virtual int vtkEnSightReader::ReadGeometryFile (  const char *  fileName,
int  timeStep
)  [protected, pure virtual]
 

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

Implemented in vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, and vtkEnSightGoldReader.

virtual int vtkEnSightReader::ReadMeasuredGeometryFile (  const char *  fileName,
int  timeStep
)  [protected, pure virtual]
 

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

Implemented in vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, and vtkEnSightGoldReader.

int vtkEnSightReader::ReadVariableFiles (   )  [protected]
 

Read the variable files. If an error occurred, 0 is returned; otherwise 1.

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

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

Implemented in vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, and vtkEnSightGoldReader.

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

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

Implemented in vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, and vtkEnSightGoldReader.

virtual int vtkEnSightReader::ReadTensorsPerNode (  const char *  fileName,
const char *  description,
int  timeStep
)  [protected, pure virtual]
 

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

Implemented in vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, and vtkEnSightGoldReader.

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

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

Implemented in vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, and vtkEnSightGoldReader.

virtual int vtkEnSightReader::ReadVectorsPerElement (  const char *  fileName,
const char *  description,
int  timeStep
)  [protected, pure virtual]
 

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

Implemented in vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, and vtkEnSightGoldReader.

virtual int vtkEnSightReader::ReadTensorsPerElement (  const char *  fileName,
const char *  description,
int  timeStep
)  [protected, pure virtual]
 

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

Implemented in vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, and vtkEnSightGoldReader.

virtual int vtkEnSightReader::CreateUnstructuredGridOutput (  int  partId,
char  line[80],
const char *  name
)  [protected, pure virtual]
 

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

Implemented in vtkEnSightGoldBinaryReader.

virtual int vtkEnSightReader::CreateStructuredGridOutput (  int  partId,
char  line[80],
const char *  name
)  [protected, pure virtual]
 

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

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

Set/Get the Model file name.

Reimplemented from vtkGenericEnSightReader.

Reimplemented in vtkEnSightGoldReader.

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

Set/Get the Model file name.

Reimplemented from vtkGenericEnSightReader.

Reimplemented in vtkEnSightGoldReader.

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

Set/Get the Measured file name.

Reimplemented in vtkEnSightGoldReader.

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

Set/Get the Measured file name.

Reimplemented in vtkEnSightGoldReader.

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

Set/Get the Match file name.

Reimplemented in vtkEnSightGoldReader.

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

Set/Get the Match file name.

Reimplemented in vtkEnSightGoldReader.

void vtkEnSightReader::AddVariableFileName (  const char *  fileName1,
const char *  fileName2 = NULL
)  [protected]
 

Add another file name to the list for a particular variable type.

void vtkEnSightReader::AddVariableDescription (  const char *  description  )  [protected]
 

Add another description to the list for a particular variable type.

Reimplemented from vtkGenericEnSightReader.

void vtkEnSightReader::AddVariableType (   )  [protected]
 

Record the variable type for the variable line just read.

int vtkEnSightReader::GetElementType (  const char *  line  )  [protected]
 

Determine the element type from a line read a file. Return -1 for invalid element type.

int vtkEnSightReader::GetSectionType (  const char *  line  )  [protected]
 

Determine the section type from a line read a file. Return -1 for invalid section type.

void vtkEnSightReader::ReplaceWildcards (  char *  filename,
int  num
)  [protected]
 

Replace the *'s in the filename with the given filename number.

vtkIdList* vtkEnSightReader::GetCellIds (  int  index,
int  cellType
)  [protected]
 

virtual void vtkEnSightReader::SetUseTimeSets (  int   )  [protected, virtual]
 

virtual int vtkEnSightReader::GetUseTimeSets (   )  [protected, virtual]
 

virtual void vtkEnSightReader::UseTimeSetsOn (   )  [protected, virtual]
 

virtual void vtkEnSightReader::UseTimeSetsOff (   )  [protected, virtual]
 

virtual void vtkEnSightReader::SetUseFileSets (  int   )  [protected, virtual]
 

virtual int vtkEnSightReader::GetUseFileSets (   )  [protected, virtual]
 

virtual void vtkEnSightReader::UseFileSetsOn (   )  [protected, virtual]
 

virtual void vtkEnSightReader::UseFileSetsOff (   )  [protected, virtual]
 

void vtkEnSightReader::SetNumberOfOutputsInternal (  int  num  )  [protected]
 

int vtkEnSightReader::CheckOutputConsistency (   )  [protected]
 

Member Data Documentation

int vtkEnSightReader::CaseFileRead [protected]
 

Definition at line 108 of file vtkEnSightReader.h.

char* vtkEnSightReader::MeasuredFileName [protected]
 

Definition at line 224 of file vtkEnSightReader.h.

char* vtkEnSightReader::MatchFileName [protected]
 

Definition at line 225 of file vtkEnSightReader.h.

vtkEnSightReaderCellIdsType* vtkEnSightReader::CellIds [protected]
 

Definition at line 228 of file vtkEnSightReader.h.

vtkIdList* vtkEnSightReader::UnstructuredPartIds [protected]
 

Definition at line 231 of file vtkEnSightReader.h.

int vtkEnSightReader::VariableMode [protected]
 

Definition at line 233 of file vtkEnSightReader.h.

char** vtkEnSightReader::VariableFileNames [protected]
 

Definition at line 236 of file vtkEnSightReader.h.

char** vtkEnSightReader::ComplexVariableFileNames [protected]
 

Definition at line 237 of file vtkEnSightReader.h.

vtkIdList* vtkEnSightReader::VariableTimeSetIds [protected]
 

Definition at line 240 of file vtkEnSightReader.h.

vtkIdList* vtkEnSightReader::ComplexVariableTimeSetIds [protected]
 

Definition at line 241 of file vtkEnSightReader.h.

vtkIdList* vtkEnSightReader::VariableFileSetIds [protected]
 

Definition at line 244 of file vtkEnSightReader.h.

vtkIdList* vtkEnSightReader::ComplexVariableFileSetIds [protected]
 

Definition at line 245 of file vtkEnSightReader.h.

vtkIdListCollection* vtkEnSightReader::TimeSetFileNameNumbers [protected]
 

Definition at line 248 of file vtkEnSightReader.h.

vtkIdList* vtkEnSightReader::TimeSetsWithFilenameNumbers [protected]
 

Definition at line 249 of file vtkEnSightReader.h.

vtkIdListCollection* vtkEnSightReader::FileSetFileNameNumbers [protected]
 

Definition at line 252 of file vtkEnSightReader.h.

vtkIdList* vtkEnSightReader::FileSetsWithFilenameNumbers [protected]
 

Definition at line 253 of file vtkEnSightReader.h.

vtkIdListCollection* vtkEnSightReader::FileSetNumberOfSteps [protected]
 

Definition at line 256 of file vtkEnSightReader.h.

vtkIdList* vtkEnSightReader::TimeSetIds [protected]
 

Definition at line 259 of file vtkEnSightReader.h.

vtkIdList* vtkEnSightReader::FileSets [protected]
 

Definition at line 260 of file vtkEnSightReader.h.

int vtkEnSightReader::GeometryTimeSet [protected]
 

Definition at line 262 of file vtkEnSightReader.h.

int vtkEnSightReader::GeometryFileSet [protected]
 

Definition at line 263 of file vtkEnSightReader.h.

int vtkEnSightReader::MeasuredTimeSet [protected]
 

Definition at line 264 of file vtkEnSightReader.h.

int vtkEnSightReader::MeasuredFileSet [protected]
 

Definition at line 265 of file vtkEnSightReader.h.

float vtkEnSightReader::GeometryTimeValue [protected]
 

Definition at line 267 of file vtkEnSightReader.h.

float vtkEnSightReader::MeasuredTimeValue [protected]
 

Definition at line 268 of file vtkEnSightReader.h.

int vtkEnSightReader::UseTimeSets [protected]
 

Definition at line 270 of file vtkEnSightReader.h.

int vtkEnSightReader::UseFileSets [protected]
 

Definition at line 273 of file vtkEnSightReader.h.

int vtkEnSightReader::NumberOfGeometryParts [protected]
 

Definition at line 278 of file vtkEnSightReader.h.

int vtkEnSightReader::NumberOfMeasuredPoints [protected]
 

Definition at line 285 of file vtkEnSightReader.h.

int vtkEnSightReader::NumberOfNewOutputs [protected]
 

Definition at line 287 of file vtkEnSightReader.h.

int vtkEnSightReader::OutputsAreValid [protected]
 

Definition at line 288 of file vtkEnSightReader.h.

int vtkEnSightReader::InitialRead [protected]
 

Definition at line 289 of file vtkEnSightReader.h.

The documentation for this class was generated from the following file:
Generated on Mon Jan 21 23:42:30 2008 for VTK by  doxygen 1.4.3-20050530