reads a dataset in AVS "UCD" format More...

#include <vtkAVSucdReader.h>

Inheritance diagram for vtkAVSucdReader:

Collaboration diagram for vtkAVSucdReader:

Classes
struct	DataInfo

Public Types
typedef vtkUnstructuredGridAlgorithm	Superclass

Public Types inherited from vtkUnstructuredGridAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkAVSucdReader *	NewInstance () const

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)

Public Member Functions inherited from vtkUnstructuredGridAlgorithm
vtkUnstructuredGridAlgorithm *	NewInstance () const

vtkDataObject *	GetInput (int port)

vtkDataObject *	GetInput ()

vtkUnstructuredGrid *	GetUnstructuredGridInput (int port)

vtkUnstructuredGrid *	GetOutput ()

vtkUnstructuredGrid *	GetOutput (int)

virtual void	SetOutput (vtkDataObject *d)

virtual int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

void	AddInputData (vtkDataObject *)

void	AddInputData (int, vtkDataObject *)

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, unsigned long *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

void	SetProgressText (const char *ptext)

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int extent[6])

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkAVSucdReader *	New ()

static int	IsTypeOf (const char *type)

static vtkAVSucdReader *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkUnstructuredGridAlgorithm
static vtkUnstructuredGridAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkUnstructuredGridAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

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
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAVSucdReader ()

	~vtkAVSucdReader ()

int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

int	GetLabel (char string, int number, char label)

Protected Member Functions inherited from vtkUnstructuredGridAlgorithm
	vtkUnstructuredGridAlgorithm ()

	~vtkUnstructuredGridAlgorithm ()

virtual int	FillOutputPortInformation (int port, vtkInformation *info)

virtual int	FillInputPortInformation (int port, vtkInformation *info)

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm ()

virtual void	SetNumberOfInputPorts (int n)

virtual void	SetNumberOfOutputPorts (int n)

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)

virtual vtkExecutive *	CreateDefaultExecutive ()

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	SetNumberOfInputConnections (int port, int n)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

virtual void	SetErrorCode (unsigned long)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

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	ByteOrder

DataInfo *	NodeDataInfo

DataInfo *	CellDataInfo

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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

Examples:: vtkAVSucdReader (Examples)

Tests:: vtkAVSucdReader (Tests)

Definition at line 52 of file vtkAVSucdReader.h.

Member Typedef Documentation

typedef vtkUnstructuredGridAlgorithm vtkAVSucdReader::Superclass

Definition at line 56 of file vtkAVSucdReader.h.

Member Enumeration Documentation

anonymous enum

protected

Enumerator
FILE_BIG_ENDIAN
FILE_LITTLE_ENDIAN

Definition at line 168 of file vtkAVSucdReader.h.

enum vtkAVSucdReader::UCDCell_type

protected

Enumerator
PT
LINE
TRI
QUAD
TET
PYR
PRISM
HEX

Definition at line 173 of file vtkAVSucdReader.h.

Constructor & Destructor Documentation

vtkAVSucdReader::vtkAVSucdReader ( )

protected

vtkAVSucdReader::~vtkAVSucdReader ( )

protected

Member Function Documentation

static vtkAVSucdReader* vtkAVSucdReader::New ( )

static

static int vtkAVSucdReader::IsTypeOf ( const char * type )

static

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkUnstructuredGridAlgorithm.

static vtkAVSucdReader* vtkAVSucdReader::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkAVSucdReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkUnstructuredGridAlgorithm.

vtkAVSucdReader* vtkAVSucdReader::NewInstance ( ) const

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 ( )