vtkEnSightReader Class Reference

#include <vtkEnSightReader.h>

Inheritance diagram for vtkEnSightReader:

[legend]

Collaboration diagram for vtkEnSightReader:

[legend]

List of all members.

Detailed Description

superclass for EnSight file readers

Definition at line 30 of file vtkEnSightReader.h.


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 const char *	GetClassName ()
virtual int	IsA (const char *type)
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 vtkEnSightReader *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkEnSightReader ()
	~vtkEnSightReader ()
virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
int	ReadCaseFile ()
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)
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 ()
int	CheckOutputConsistency ()

virtual void	SetMeasuredFileName (const char *)

virtual void	SetMatchFileName (const char *)

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)

vtkDataSet *	GetDataSetFromBlock (vtkMultiBlockDataSet *output, unsigned int blockNo)
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	InitialRead
int	ParticleCoordinatesByIndex
double	ActualTimeValue

Member Typedef Documentation

typedef vtkGenericEnSightReader vtkEnSightReader::Superclass

Reimplemented from vtkGenericEnSightReader.

Reimplemented in vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, and vtkEnSightGoldReader.

Definition at line 33 of file vtkEnSightReader.h.

Member Enumeration Documentation

enum vtkEnSightReader::ElementTypesList

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

enum vtkEnSightReader::SectionTypeList

Enumerator:

COORDINATES
BLOCK
ELEMENT

Definition at line 75 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 * 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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkGenericEnSightReader.

Reimplemented in vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, and vtkEnSightGoldReader.

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 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.

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.

virtual void vtkEnSightReader::SetParticleCoordinatesByIndex ( int ) [virtual]

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.

virtual int vtkEnSightReader::GetParticleCoordinatesByIndex ( ) [virtual]

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.

virtual void vtkEnSightReader::ParticleCoordinatesByIndexOn ( ) [virtual]

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.

virtual void vtkEnSightReader::ParticleCoordinatesByIndexOff ( ) [virtual]

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.

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

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.

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,
		vtkMultiBlockDataSet *	output
	)			`[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,
		vtkMultiBlockDataSet *	output
	)			`[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 ( vtkMultiBlockDataSet * output ) [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,
		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 vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, 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 vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, 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 vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, 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 vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, 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 vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, 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 vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, 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]`