vtkAVSucdReader Class Reference

#include <vtkAVSucdReader.h>

Inheritance diagram for vtkAVSucdReader:

[legend]

Collaboration diagram for vtkAVSucdReader:

[legend]

List of all members.

Detailed Description

reads a dataset in AVS "UCD" format

vtkAVSucdReader creates an unstructured grid dataset. It reads binary or ASCII files stored in UCD format, with optional data stored at the nodes or at the cells of the model. A cell-based fielddata stores the material id. The class can automatically detect the endian-ness of the binary files.

Thanks:: Thanks to Guenole Harel and Emmanuel Colin (Supelec engineering school, France) and Jean M. Favre (CSCS, Switzerland) who co-developed this class. Thanks to Isabelle Surin (isabelle.surin at cea.fr, CEA-DAM, France) who supervised the internship of the first two authors. Thanks to Daniel Aguilera (daniel.aguilera at cea.fr, CEA-DAM, France) who contributed code and advice. Please address all comments to Jean Favre (jfavre at cscs.ch)

See also:: vtkGAMBITReader

Tests:: vtkAVSucdReader (Tests)

Definition at line 48 of file vtkAVSucdReader.h.


Public Types
typedef vtkUnstructuredGridAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetByteOrder (int)
virtual int	GetByteOrder ()
void	DisableAllCellArrays ()
void	EnableAllCellArrays ()
void	DisableAllPointArrays ()
void	EnableAllPointArrays ()
void	GetCellDataRange (int cellComp, int index, float min, float max)
void	GetNodeDataRange (int nodeComp, int index, float min, float max)

virtual void	SetFileName (const char *)
virtual char *	GetFileName ()

virtual void	SetBinaryFile (int)
virtual int	GetBinaryFile ()
virtual void	BinaryFileOn ()
virtual void	BinaryFileOff ()

virtual int	GetNumberOfCells ()

virtual int	GetNumberOfNodes ()

virtual int	GetNumberOfNodeFields ()

virtual int	GetNumberOfCellFields ()

virtual int	GetNumberOfFields ()

virtual int	GetNumberOfNodeComponents ()
virtual int	GetNumberOfCellComponents ()

void	SetByteOrderToBigEndian ()
void	SetByteOrderToLittleEndian ()
const char *	GetByteOrderAsString ()

int	GetNumberOfPointArrays ()
int	GetNumberOfCellArrays ()
const char *	GetPointArrayName (int index)
const char *	GetCellArrayName (int index)
int	GetPointArrayStatus (const char *name)
int	GetCellArrayStatus (const char *name)
void	SetPointArrayStatus (const char *name, int status)
void	SetCellArrayStatus (const char *name, int status)
Static Public Member Functions
static vtkAVSucdReader *	New ()
static int	IsTypeOf (const char *type)
static vtkAVSucdReader *	SafeDownCast (vtkObject *o)
Protected Types
enum	{ FILE_BIG_ENDIAN = 0, FILE_LITTLE_ENDIAN = 1 }
enum	UCDCell_type { PT = 0, LINE = 1, TRI = 2, QUAD = 3, TET = 4, PYR = 5, PRISM = 6, HEX = 7 }
Protected Member Functions
	vtkAVSucdReader ()
	~vtkAVSucdReader ()
int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
int	GetLabel (char string, int number, char label)
Protected Attributes
char *	FileName
int	BinaryFile
int	NumberOfNodes
int	NumberOfCells
int	NumberOfNodeFields
int	NumberOfNodeComponents
int	NumberOfCellComponents
int	NumberOfCellFields
int	NumberOfFields
int	NlistNodes
ifstream *	FileStream
vtkDataArraySelection *	PointDataArraySelection
vtkDataArraySelection *	CellDataArraySelection
int	DecrementNodeIds
int	ByteOrder
DataInfo *	NodeDataInfo
DataInfo *	CellDataInfo
Classes
struct	DataInfo

Member Typedef Documentation

typedef vtkUnstructuredGridAlgorithm vtkAVSucdReader::Superclass

Reimplemented from vtkUnstructuredGridAlgorithm.

Definition at line 52 of file vtkAVSucdReader.h.

Member Enumeration Documentation

anonymous enum [protected]

Enumerator:

FILE_BIG_ENDIAN
FILE_LITTLE_ENDIAN

Definition at line 165 of file vtkAVSucdReader.h.

enum vtkAVSucdReader::UCDCell_type [protected]

Enumerator:

PT
LINE
TRI
QUAD
TET
PYR
PRISM
HEX

Definition at line 170 of file vtkAVSucdReader.h.

Constructor & Destructor Documentation

vtkAVSucdReader::vtkAVSucdReader ( ) [protected]

vtkAVSucdReader::~vtkAVSucdReader ( ) [protected]

Member Function Documentation

static vtkAVSucdReader* vtkAVSucdReader::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkUnstructuredGridAlgorithm.

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

Reimplemented from vtkUnstructuredGridAlgorithm.

static int vtkAVSucdReader::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 vtkUnstructuredGridAlgorithm.

virtual int vtkAVSucdReader::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 vtkUnstructuredGridAlgorithm.

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

Reimplemented from vtkUnstructuredGridAlgorithm.

void vtkAVSucdReader::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 vtkUnstructuredGridAlgorithm.

virtual void vtkAVSucdReader::SetFileName ( const char * ) [virtual]

Specify file name of AVS UCD datafile to read

virtual char* vtkAVSucdReader::GetFileName ( ) [virtual]

Specify file name of AVS UCD datafile to read

virtual void vtkAVSucdReader::SetBinaryFile ( int ) [virtual]

Is the file to be read written in binary format (as opposed to ascii).

virtual int vtkAVSucdReader::GetBinaryFile ( ) [virtual]

Is the file to be read written in binary format (as opposed to ascii).

virtual void vtkAVSucdReader::BinaryFileOn ( ) [virtual]

Is the file to be read written in binary format (as opposed to ascii).

virtual void vtkAVSucdReader::BinaryFileOff ( ) [virtual]

Is the file to be read written in binary format (as opposed to ascii).

virtual int vtkAVSucdReader::GetNumberOfCells ( ) [virtual]

Get the total number of cells.

virtual int vtkAVSucdReader::GetNumberOfNodes ( ) [virtual]

Get the total number of nodes.

virtual int vtkAVSucdReader::GetNumberOfNodeFields ( ) [virtual]

Get the number of data fields at the nodes.

virtual int vtkAVSucdReader::GetNumberOfCellFields ( ) [virtual]

Get the number of data fields at the cell centers.

virtual int vtkAVSucdReader::GetNumberOfFields ( ) [virtual]

Get the number of data fields for the model. Unused because VTK has no methods for it.

virtual int vtkAVSucdReader::GetNumberOfNodeComponents ( ) [virtual]

Get the number of data components at the nodes and cells.

virtual int vtkAVSucdReader::GetNumberOfCellComponents ( ) [virtual]

Get the number of data components at the nodes and cells.

void vtkAVSucdReader::SetByteOrderToBigEndian ( )

Set/Get the endian-ness of the binary file.

void vtkAVSucdReader::SetByteOrderToLittleEndian ( )

Set/Get the endian-ness of the binary file.

const char* vtkAVSucdReader::GetByteOrderAsString ( )

Set/Get the endian-ness of the binary file.

virtual void vtkAVSucdReader::SetByteOrder ( int ) [virtual]

virtual int vtkAVSucdReader::GetByteOrder ( ) [virtual]

int vtkAVSucdReader::GetNumberOfPointArrays ( )