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

vtkAVSucdReader Class Reference

#include <vtkAVSucdReader.h>

Inheritance diagram for vtkAVSucdReader:

Inheritance graph
[legend]
Collaboration diagram for vtkAVSucdReader:

Collaboration graph
[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
Created by:
  • Schroeder, Will
CVS contributions (if > 5%):
  • Schroeder, Will (76%)
  • Malaterre, Mathieu (22%)
CVS logs (CVSweb):
  • .h (/IO/vtkAVSucdReader.h)
  • .cxx (/IO/vtkAVSucdReader.cxx)
Tests:
vtkAVSucdReader (Tests)

Definition at line 59 of file vtkAVSucdReader.h.

Public Types

typedef vtkUnstructuredGridSource 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

vtkAVSucdReaderNew ()
int IsTypeOf (const char *type)
vtkAVSucdReaderSafeDownCast (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 ()
void ExecuteInformation ()
void Execute ()
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
vtkDataArraySelectionPointDataArraySelection
vtkDataArraySelectionCellDataArraySelection
int DecrementNodeIds
int ByteOrder
DataInfoNodeDataInfo
DataInfoCellDataInfo


Member Typedef Documentation

typedef vtkUnstructuredGridSource vtkAVSucdReader::Superclass
 

Reimplemented from vtkUnstructuredGridSource.

Definition at line 63 of file vtkAVSucdReader.h.


Member Enumeration Documentation

anonymous enum [protected]
 

Enumeration values:
FILE_BIG_ENDIAN 
FILE_LITTLE_ENDIAN 

Definition at line 176 of file vtkAVSucdReader.h.

enum vtkAVSucdReader::UCDCell_type [protected]
 

Enumeration values:
PT 
LINE 
TRI 
QUAD 
TET 
PYR 
PRISM 
HEX 

Definition at line 181 of file vtkAVSucdReader.h.


Constructor & Destructor Documentation

vtkAVSucdReader::vtkAVSucdReader  )  [protected]
 

vtkAVSucdReader::~vtkAVSucdReader  )  [protected]
 


Member Function Documentation

vtkAVSucdReader* vtkAVSucdReader::New  )  [static]
 

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

Reimplemented from vtkAlgorithm.

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

Reimplemented from vtkUnstructuredGridSource.

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

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

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

Reimplemented from vtkUnstructuredGridSource.

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

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  ) 
 

The following methods allow selective reading of solutions fields. by default, ALL data fields are the nodes and cells are read, but this can be modified.

int vtkAVSucdReader::GetNumberOfCellArrays  ) 
 

The following methods allow selective reading of solutions fields. by default, ALL data fields are the nodes and cells are read, but this can be modified.

const char* vtkAVSucdReader::GetPointArrayName int  index  ) 
 

The following methods allow selective reading of solutions fields. by default, ALL data fields are the nodes and cells are read, but this can be modified.

const char* vtkAVSucdReader::GetCellArrayName int  index  ) 
 

The following methods allow selective reading of solutions fields. by default, ALL data fields are the nodes and cells are read, but this can be modified.

int vtkAVSucdReader::GetPointArrayStatus const char *  name  ) 
 

The following methods allow selective reading of solutions fields. by default, ALL data fields are the nodes and cells are read, but this can be modified.

int vtkAVSucdReader::GetCellArrayStatus const char *  name  ) 
 

The following methods allow selective reading of solutions fields. by default, ALL data fields are the nodes and cells are read, but this can be modified.

void vtkAVSucdReader::SetPointArrayStatus const char *  name,
int  status
 

The following methods allow selective reading of solutions fields. by default, ALL data fields are the nodes and cells are read, but this can be modified.

void vtkAVSucdReader::SetCellArrayStatus const char *  name,
int  status
 

The following methods allow selective reading of solutions fields. by default, ALL data fields are the nodes and cells are read, but this can be modified.

void vtkAVSucdReader::DisableAllCellArrays  ) 
 

void vtkAVSucdReader::EnableAllCellArrays  ) 
 

void vtkAVSucdReader::DisableAllPointArrays  ) 
 

void vtkAVSucdReader::EnableAllPointArrays  ) 
 

void vtkAVSucdReader::GetCellDataRange int  cellComp,
int  index,
float *  min,
float *  max
 

void vtkAVSucdReader::GetNodeDataRange int  nodeComp,
int  index,
float *  min,
float *  max
 

void vtkAVSucdReader::ExecuteInformation  )  [protected, virtual]
 

Reimplemented from vtkSource.

void vtkAVSucdReader::Execute  )  [protected, virtual]
 

This method is the old style execute method

Reimplemented from vtkSource.

int vtkAVSucdReader::GetLabel char *  string,
int  number,
char *  label
[protected]
 


Member Data Documentation

char* vtkAVSucdReader::FileName [protected]
 

Definition at line 155 of file vtkAVSucdReader.h.

int vtkAVSucdReader::BinaryFile [protected]
 

Definition at line 156 of file vtkAVSucdReader.h.

int vtkAVSucdReader::NumberOfNodes [protected]
 

Definition at line 158 of file vtkAVSucdReader.h.

int vtkAVSucdReader::NumberOfCells [protected]
 

Definition at line 159 of file vtkAVSucdReader.h.

int vtkAVSucdReader::NumberOfNodeFields [protected]
 

Definition at line 160 of file vtkAVSucdReader.h.

int vtkAVSucdReader::NumberOfNodeComponents [protected]
 

Definition at line 161 of file vtkAVSucdReader.h.

int vtkAVSucdReader::NumberOfCellComponents [protected]
 

Definition at line 162 of file vtkAVSucdReader.h.

int vtkAVSucdReader::NumberOfCellFields [protected]
 

Definition at line 163 of file vtkAVSucdReader.h.

int vtkAVSucdReader::NumberOfFields [protected]
 

Definition at line 164 of file vtkAVSucdReader.h.

int vtkAVSucdReader::NlistNodes [protected]
 

Definition at line 165 of file vtkAVSucdReader.h.

ifstream* vtkAVSucdReader::FileStream [protected]
 

Definition at line 167 of file vtkAVSucdReader.h.

vtkDataArraySelection* vtkAVSucdReader::PointDataArraySelection [protected]
 

Definition at line 169 of file vtkAVSucdReader.h.

vtkDataArraySelection* vtkAVSucdReader::CellDataArraySelection [protected]
 

Definition at line 170 of file vtkAVSucdReader.h.

int vtkAVSucdReader::DecrementNodeIds [protected]
 

Definition at line 172 of file vtkAVSucdReader.h.

int vtkAVSucdReader::ByteOrder [protected]
 

Definition at line 173 of file vtkAVSucdReader.h.

DataInfo* vtkAVSucdReader::NodeDataInfo [protected]
 

Definition at line 201 of file vtkAVSucdReader.h.

DataInfo* vtkAVSucdReader::CellDataInfo [protected]
 

Definition at line 202 of file vtkAVSucdReader.h.


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