VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkEnSightReader Class Reference

superclass for EnSight file readers More...

#include <vtkEnSightReader.h>

Inheritance diagram for vtkEnSightReader:
Inheritance graph
[legend]
Collaboration diagram for vtkEnSightReader:
Collaboration graph
[legend]

List of all members.

Public Types

enum  ElementTypesList {
  POINT = 0, BAR2 = 1, BAR3 = 2, NSIDED = 3,
  TRIA3 = 4, TRIA6 = 5, QUAD4 = 6, QUAD8 = 7,
  NFACED = 8, TETRA4 = 9, TETRA10 = 10, PYRAMID5 = 11,
  PYRAMID13 = 12, HEXA8 = 13, HEXA20 = 14, PENTA6 = 15,
  PENTA15 = 16, NUMBER_OF_ELEMENT_TYPES = 17
}
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 }
typedef vtkGenericEnSightReader Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkEnSightReaderNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual char * GetMeasuredFileName ()
virtual char * GetMatchFileName ()
virtual void SetParticleCoordinatesByIndex (int)
virtual int GetParticleCoordinatesByIndex ()
virtual void ParticleCoordinatesByIndexOn ()
virtual void ParticleCoordinatesByIndexOff ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkEnSightReaderSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkEnSightReader ()
 ~vtkEnSightReader ()
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int ReadVariableFiles (vtkMultiBlockDataSet *output)
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)
void RemoveLeadingBlanks (char *line)
vtkIdListGetCellIds (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 ()
int CheckOutputConsistency ()
virtual void SetMeasuredFileName (const char *)
virtual void SetMatchFileName (const char *)
int ReadCaseFile ()
int ReadCaseFileGeometry (char *line)
int ReadCaseFileVariable (char *line)
int ReadCaseFileTime (char *line)
int ReadCaseFileFile (char *line)
virtual int ReadGeometryFile (const char *fileName, int timeStep, vtkMultiBlockDataSet *output)=0
virtual int ReadMeasuredGeometryFile (const char *fileName, int timeStep, vtkMultiBlockDataSet *output)=0
virtual int ReadScalarsPerNode (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output, int measured=0, int numberOfComponents=1, int component=0)=0
virtual int ReadVectorsPerNode (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output, int measured=0)=0
virtual int ReadTensorsPerNode (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output)=0
virtual int ReadScalarsPerElement (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output, int numberOfComponents=1, int component=0)=0
virtual int ReadVectorsPerElement (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output)=0
virtual int ReadTensorsPerElement (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output)=0
virtual int CreateUnstructuredGridOutput (int partId, char line[80], const char *name, vtkMultiBlockDataSet *output)=0
virtual int CreateStructuredGridOutput (int partId, char line[80], const char *name, vtkMultiBlockDataSet *output)=0
void AddToBlock (vtkMultiBlockDataSet *output, unsigned int blockNo, vtkDataSet *dataset)
vtkDataSetGetDataSetFromBlock (vtkMultiBlockDataSet *output, unsigned int blockNo)
void SetBlockName (vtkMultiBlockDataSet *output, unsigned int blockNo, const char *name)

Protected Attributes

int CaseFileRead
char * MeasuredFileName
char * MatchFileName
vtkEnSightReaderCellIdsType * CellIds
vtkIdListUnstructuredPartIds
int VariableMode
char ** VariableFileNames
char ** ComplexVariableFileNames
vtkIdListVariableTimeSetIds
vtkIdListComplexVariableTimeSetIds
vtkIdListVariableFileSetIds
vtkIdListComplexVariableFileSetIds
vtkIdListCollectionTimeSetFileNameNumbers
vtkIdListTimeSetsWithFilenameNumbers
vtkIdListCollectionFileSetFileNameNumbers
vtkIdListFileSetsWithFilenameNumbers
vtkIdListCollectionFileSetNumberOfSteps
vtkIdListTimeSetIds
vtkIdListFileSets
int GeometryTimeSet
int GeometryFileSet
int MeasuredTimeSet
int MeasuredFileSet
float GeometryTimeValue
float MeasuredTimeValue
int UseTimeSets
int UseFileSets
int NumberOfGeometryParts
int NumberOfMeasuredPoints
int NumberOfNewOutputs
int InitialRead
int ParticleCoordinatesByIndex
double ActualTimeValue

Detailed Description

superclass for EnSight file readers

Definition at line 32 of file vtkEnSightReader.h.


Member Typedef Documentation


Member Enumeration Documentation

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

Definition at line 39 of file vtkEnSightReader.h.

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 61 of file vtkEnSightReader.h.

Enumerator:
COORDINATES 
BLOCK 
ELEMENT 

Definition at line 77 of file vtkEnSightReader.h.


Constructor & Destructor Documentation


Member Function Documentation

static int vtkEnSightReader::IsTypeOf ( const char *  name) [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 vtkGenericEnSightReader.

Reimplemented in vtkEnSightGoldBinaryReader, vtkEnSightGoldReader, vtkEnSight6BinaryReader, and vtkEnSight6Reader.

virtual int vtkEnSightReader::IsA ( const char *  name) [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 vtkGenericEnSightReader.

Reimplemented in vtkEnSightGoldBinaryReader, vtkEnSightGoldReader, vtkEnSight6BinaryReader, and vtkEnSight6Reader.

virtual vtkObjectBase* vtkEnSightReader::NewInstanceInternal ( ) const [protected, virtual]
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 vtkEnSightGoldBinaryReader, vtkEnSightGoldReader, vtkEnSight6BinaryReader, and vtkEnSight6Reader.

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

Get the Measured file name. Made public to allow access from apps requiring detailed info about the Data contents

Reimplemented in vtkEnSightGoldReader.

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

Get the Match file name. Made public to allow access from apps requiring detailed info about the Data contents

Reimplemented in vtkEnSightGoldReader.

The MeasuredGeometryFile should list particle coordinates from 0->N-1. If a file is loaded where point Ids are listed from 1-N the Id to points reference will be wrong and the data will be generated incorrectly. Setting ParticleCoordinatesByIndex to true will force all Id's to increment from 0->N-1 (relative to their order in the file) and regardless of the actual Id of of the point. Warning, if the Points are listed in non sequential order then setting this flag will reorder them.

Reimplemented from vtkGenericEnSightReader.

The MeasuredGeometryFile should list particle coordinates from 0->N-1. If a file is loaded where point Ids are listed from 1-N the Id to points reference will be wrong and the data will be generated incorrectly. Setting ParticleCoordinatesByIndex to true will force all Id's to increment from 0->N-1 (relative to their order in the file) and regardless of the actual Id of of the point. Warning, if the Points are listed in non sequential order then setting this flag will reorder them.

Reimplemented from vtkGenericEnSightReader.

The MeasuredGeometryFile should list particle coordinates from 0->N-1. If a file is loaded where point Ids are listed from 1-N the Id to points reference will be wrong and the data will be generated incorrectly. Setting ParticleCoordinatesByIndex to true will force all Id's to increment from 0->N-1 (relative to their order in the file) and regardless of the actual Id of of the point. Warning, if the Points are listed in non sequential order then setting this flag will reorder them.

Reimplemented from vtkGenericEnSightReader.

The MeasuredGeometryFile should list particle coordinates from 0->N-1. If a file is loaded where point Ids are listed from 1-N the Id to points reference will be wrong and the data will be generated incorrectly. Setting ParticleCoordinatesByIndex to true will force all Id's to increment from 0->N-1 (relative to their order in the file) and regardless of the actual Id of of the point. Warning, if the Points are listed in non sequential order then setting this flag will reorder them.

Reimplemented from vtkGenericEnSightReader.

This is called by the superclass. This is the method you should override.

Reimplemented from vtkGenericEnSightReader.

virtual int vtkEnSightReader::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkGenericEnSightReader.

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

Set the Measured file name.

Reimplemented in vtkEnSightGoldReader.

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

Set the Match file name.

Reimplemented in vtkEnSightGoldReader.

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

int vtkEnSightReader::ReadCaseFileGeometry ( char *  line) [protected]

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

int vtkEnSightReader::ReadCaseFileVariable ( char *  line) [protected]

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

int vtkEnSightReader::ReadCaseFileTime ( char *  line) [protected]

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

int vtkEnSightReader::ReadCaseFileFile ( char *  line) [protected]

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

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

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

Implemented in vtkEnSightGoldBinaryReader, vtkEnSight6BinaryReader, vtkEnSightGoldReader, and vtkEnSight6Reader.

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

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

Implemented in vtkEnSightGoldBinaryReader, vtkEnSight6BinaryReader, vtkEnSightGoldReader, and vtkEnSight6Reader.

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,
vtkMultiBlockDataSet output,
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 vtkEnSightGoldBinaryReader, vtkEnSight6BinaryReader, vtkEnSight6Reader, and vtkEnSightGoldReader.

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

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

Implemented in vtkEnSightGoldBinaryReader, vtkEnSight6BinaryReader, vtkEnSight6Reader, and vtkEnSightGoldReader.

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

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

Implemented in vtkEnSightGoldBinaryReader, vtkEnSight6BinaryReader, vtkEnSight6Reader, and vtkEnSightGoldReader.

virtual int vtkEnSightReader::ReadScalarsPerElement ( const char *  fileName,
const char *  description,
int  timeStep,
vtkMultiBlockDataSet output,
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 vtkEnSightGoldBinaryReader, vtkEnSight6BinaryReader, vtkEnSight6Reader, and vtkEnSightGoldReader.

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

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

Implemented in vtkEnSightGoldBinaryReader, vtkEnSight6BinaryReader, vtkEnSight6Reader, and vtkEnSightGoldReader.

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

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

Implemented in vtkEnSightGoldBinaryReader, vtkEnSight6BinaryReader, vtkEnSight6Reader, and vtkEnSightGoldReader.

virtual int vtkEnSightReader::CreateUnstructuredGridOutput ( int  partId,
char  line[80],
const char *  name,
vtkMultiBlockDataSet output 
) [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,
vtkMultiBlockDataSet output 
) [protected, pure virtual]

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

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.

void vtkEnSightReader::RemoveLeadingBlanks ( char *  line) [protected]

Remove leading blank spaces from a string.

vtkIdList* vtkEnSightReader::GetCellIds ( int  index,
int  cellType 
) [protected]
void vtkEnSightReader::AddToBlock ( vtkMultiBlockDataSet output,
unsigned int  blockNo,
vtkDataSet dataset 
) [protected]

Convenience method use to convert the readers from VTK 5 multiblock API to the current composite data infrastructure.

vtkDataSet* vtkEnSightReader::GetDataSetFromBlock ( vtkMultiBlockDataSet output,
unsigned int  blockNo 
) [protected]

Convenience method use to convert the readers from VTK 5 multiblock API to the current composite data infrastructure.

void vtkEnSightReader::SetBlockName ( vtkMultiBlockDataSet output,
unsigned int  blockNo,
const char *  name 
) [protected]

Set the name of a block.

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]

Member Data Documentation

Definition at line 143 of file vtkEnSightReader.h.

Definition at line 275 of file vtkEnSightReader.h.

Definition at line 276 of file vtkEnSightReader.h.

vtkEnSightReaderCellIdsType* vtkEnSightReader::CellIds [protected]

Definition at line 279 of file vtkEnSightReader.h.

Definition at line 282 of file vtkEnSightReader.h.

Definition at line 284 of file vtkEnSightReader.h.

Definition at line 287 of file vtkEnSightReader.h.

Definition at line 288 of file vtkEnSightReader.h.

Definition at line 291 of file vtkEnSightReader.h.

Definition at line 292 of file vtkEnSightReader.h.

Definition at line 295 of file vtkEnSightReader.h.

Definition at line 296 of file vtkEnSightReader.h.

Definition at line 299 of file vtkEnSightReader.h.

Definition at line 300 of file vtkEnSightReader.h.

Definition at line 303 of file vtkEnSightReader.h.

Definition at line 304 of file vtkEnSightReader.h.

Definition at line 307 of file vtkEnSightReader.h.

Definition at line 310 of file vtkEnSightReader.h.

Definition at line 311 of file vtkEnSightReader.h.

Definition at line 313 of file vtkEnSightReader.h.

Definition at line 314 of file vtkEnSightReader.h.

Definition at line 315 of file vtkEnSightReader.h.

Definition at line 316 of file vtkEnSightReader.h.

Definition at line 318 of file vtkEnSightReader.h.

Definition at line 319 of file vtkEnSightReader.h.

Definition at line 321 of file vtkEnSightReader.h.

Definition at line 324 of file vtkEnSightReader.h.

Definition at line 329 of file vtkEnSightReader.h.

Definition at line 334 of file vtkEnSightReader.h.

Definition at line 336 of file vtkEnSightReader.h.

Definition at line 337 of file vtkEnSightReader.h.

Reimplemented from vtkGenericEnSightReader.

Definition at line 341 of file vtkEnSightReader.h.

Definition at line 343 of file vtkEnSightReader.h.


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