VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
vtkAVSucdReader Class Reference

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

#include <vtkAVSucdReader.h>

Inheritance diagram for vtkAVSucdReader:
[legend]
Collaboration diagram for vtkAVSucdReader:
[legend]

List of all members.

Classes

struct  DataInfo

Public Types

typedef
vtkUnstructuredGridAlgorithm 
Superclass
- Public Types inherited from vtkUnstructuredGridAlgorithm
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

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)
- Public Member Functions inherited from vtkUnstructuredGridAlgorithm
vtkDataObjectGetInput (int port)
vtkDataObjectGetInput ()
vtkUnstructuredGridGetUnstructuredGridInput (int port)
vtkUnstructuredGridGetOutput ()
vtkUnstructuredGridGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
void AddInput (vtkDataObject *)
void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
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)
vtkDataObjectGetInputDataObject (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)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkAVSucdReaderNew ()
static int IsTypeOf (const char *type)
static 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 ()
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 *)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()
- 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 vtkExecutiveCreateDefaultExecutive ()
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)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *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 &os)
 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
vtkDataArraySelectionPointDataArraySelection
vtkDataArraySelectionCellDataArraySelection
int DecrementNodeIds
int ByteOrder
DataInfoNodeDataInfo
DataInfoCellDataInfo

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.


Member Typedef Documentation

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.

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

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 
)
int vtkAVSucdReader::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

Reimplemented from vtkUnstructuredGridAlgorithm.

int vtkAVSucdReader::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

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

Reimplemented from vtkUnstructuredGridAlgorithm.

int vtkAVSucdReader::GetLabel ( char *  string,
int  number,
char *  label 
)
protected

Member Data Documentation

char* vtkAVSucdReader::FileName
protected

Definition at line 144 of file vtkAVSucdReader.h.

int vtkAVSucdReader::BinaryFile
protected

Definition at line 145 of file vtkAVSucdReader.h.

int vtkAVSucdReader::NumberOfNodes
protected

Definition at line 147 of file vtkAVSucdReader.h.

int vtkAVSucdReader::NumberOfCells
protected

Definition at line 148 of file vtkAVSucdReader.h.

int vtkAVSucdReader::NumberOfNodeFields
protected

Definition at line 149 of file vtkAVSucdReader.h.

int vtkAVSucdReader::NumberOfNodeComponents
protected

Definition at line 150 of file vtkAVSucdReader.h.

int vtkAVSucdReader::NumberOfCellComponents
protected

Definition at line 151 of file vtkAVSucdReader.h.

int vtkAVSucdReader::NumberOfCellFields
protected

Definition at line 152 of file vtkAVSucdReader.h.

int vtkAVSucdReader::NumberOfFields
protected

Definition at line 153 of file vtkAVSucdReader.h.

int vtkAVSucdReader::NlistNodes
protected

Definition at line 154 of file vtkAVSucdReader.h.

ifstream* vtkAVSucdReader::FileStream
protected

Definition at line 156 of file vtkAVSucdReader.h.

vtkDataArraySelection* vtkAVSucdReader::PointDataArraySelection
protected

Definition at line 158 of file vtkAVSucdReader.h.

vtkDataArraySelection* vtkAVSucdReader::CellDataArraySelection
protected

Definition at line 159 of file vtkAVSucdReader.h.

int vtkAVSucdReader::DecrementNodeIds
protected

Definition at line 161 of file vtkAVSucdReader.h.

int vtkAVSucdReader::ByteOrder
protected

Definition at line 162 of file vtkAVSucdReader.h.

DataInfo* vtkAVSucdReader::NodeDataInfo
protected

Definition at line 190 of file vtkAVSucdReader.h.

DataInfo* vtkAVSucdReader::CellDataInfo
protected

Definition at line 191 of file vtkAVSucdReader.h.


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