ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkXdmfReader Class Reference

Reads eXtensible Data Model and Format files. More...

#include <vtkXdmfReader.h>

Inheritance diagram for vtkXdmfReader:
Inheritance graph
[legend]
Collaboration diagram for vtkXdmfReader:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
int GetNumberOfPointArrays ()
const char * GetPointArrayName (int index)
virtual int CanReadFile (const char *filename)
virtual vtkGraphGetSIL ()
virtual void SetDomainName (const char *)
virtual char * GetDomainName ()
int GetPointArrayStatus (const char *name)
void SetPointArrayStatus (const char *name, int status)
int GetNumberOfCellArrays ()
const char * GetCellArrayName (int index)
void SetCellArrayStatus (const char *name, int status)
int GetCellArrayStatus (const char *name)
int GetNumberOfGrids ()
const char * GetGridName (int index)
void SetGridStatus (const char *gridname, int status)
int GetGridStatus (const char *gridname)
int GetNumberOfSets ()
const char * GetSetName (int index)
void SetSetStatus (const char *gridname, int status)
int GetSetStatus (const char *gridname)
int GetNumberOfSetArrays ()
const char * GetSetArrayName (int index)
int GetSetArrayStatus (const char *name)
virtual void SetStride (int, int, int)
virtual void SetStride (int[3])
virtual intGetStride ()
virtual void GetStride (int &, int &, int &)
virtual void GetStride (int[3])
virtual int GetSILUpdateStamp ()

Static Public Member Functions

static vtkXdmfReaderNew ()
static int IsTypeOf (const char *type)
static vtkXdmfReaderSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkXdmfReader ()
 ~vtkXdmfReader ()
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestDataObject (vtkInformationVector *outputVector)
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
vtkXdmfArraySelectionGetPointArraySelection ()
vtkXdmfArraySelectionGetCellArraySelection ()
vtkXdmfArraySelectionGetGridSelection ()
vtkXdmfArraySelectionGetSetsSelection ()
void PassCachedSelections ()

Protected Attributes

char * DomainName
int Stride [3]
unsigned int LastTimeIndex
vtkXdmfDocumentXdmfDocument
vtkXdmfArraySelectionPointArraysCache
vtkXdmfArraySelectionCellArraysCache
vtkXdmfArraySelectionGridsCache
vtkXdmfArraySelectionSetsCache
int SILUpdateStamp

Detailed Description

Reads eXtensible Data Model and Format files.

$Date$ $Revision$

vtkXdmfReader reads XDMF data files so that they can be visualized using VTK. The output data produced by this reader depends on the number of grids in the data file. If the data file has a single domain with a single grid, then the output type is a vtkDataSet subclass of the appropriate type, otherwise it's a vtkMultiBlockDataSet.

Refer to vtkDataReader which provides many methods for controlling the reading of the data file.

Warning:
Uses the XDMF API (http://www.xdmf.org)
See also:
vtkDataReader

Definition at line 45 of file vtkXdmfReader.h.


Constructor & Destructor Documentation

vtkXdmfReader::vtkXdmfReader ( ) [protected]
vtkXdmfReader::~vtkXdmfReader ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkDataReader.

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

Reimplemented from vtkDataReader.

static int vtkXdmfReader::IsTypeOf ( const char *  type) [static]

Reimplemented from vtkDataReader.

virtual int vtkXdmfReader::IsA ( const char *  type) [virtual]

Reimplemented from vtkDataReader.

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

Reimplemented from vtkDataReader.

void vtkXdmfReader::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Reimplemented from vtkDataReader.

virtual void vtkXdmfReader::SetDomainName ( const char *  ) [virtual]

Set the active domain. Only one domain can be selected at a time. By default the first domain in the datafile is chosen. Setting this to null results in the domain being automatically chosen. Note that if the domain name is changed, you should explicitly call UpdateInformation() before accessing information about grids, data arrays etc.

virtual char* vtkXdmfReader::GetDomainName ( ) [virtual]

Set the active domain. Only one domain can be selected at a time. By default the first domain in the datafile is chosen. Setting this to null results in the domain being automatically chosen. Note that if the domain name is changed, you should explicitly call UpdateInformation() before accessing information about grids, data arrays etc.

int vtkXdmfReader::GetNumberOfPointArrays ( )

Get information about point-based arrays. As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.

const char* vtkXdmfReader::GetPointArrayName ( int  index)

Returns the name of point array at the give index. Returns NULL if index is invalid.

int vtkXdmfReader::GetPointArrayStatus ( const char *  name)

Get/Set the point array status.

void vtkXdmfReader::SetPointArrayStatus ( const char *  name,
int  status 
)

Get/Set the point array status.

int vtkXdmfReader::GetNumberOfCellArrays ( )

Get information about cell-based arrays. As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.

const char* vtkXdmfReader::GetCellArrayName ( int  index)

Get information about cell-based arrays. As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.

void vtkXdmfReader::SetCellArrayStatus ( const char *  name,
int  status 
)

Get information about cell-based arrays. As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.

int vtkXdmfReader::GetCellArrayStatus ( const char *  name)

Get information about cell-based arrays. As is typical with readers this in only valid after the filename is set and UpdateInformation() has been called.

int vtkXdmfReader::GetNumberOfGrids ( )

Get/Set information about grids. As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called.

const char* vtkXdmfReader::GetGridName ( int  index)

Get/Set information about grids. As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called.

void vtkXdmfReader::SetGridStatus ( const char *  gridname,
int  status 
)

Get/Set information about grids. As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called.

int vtkXdmfReader::GetGridStatus ( const char *  gridname)

Get/Set information about grids. As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called.

int vtkXdmfReader::GetNumberOfSets ( )

Get/Set information about sets. As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called. Note that sets with non-zero Ghost value are not treated as sets that the user can select using this API.

const char* vtkXdmfReader::GetSetName ( int  index)

Get/Set information about sets. As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called. Note that sets with non-zero Ghost value are not treated as sets that the user can select using this API.

void vtkXdmfReader::SetSetStatus ( const char *  gridname,
int  status 
)

Get/Set information about sets. As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called. Note that sets with non-zero Ghost value are not treated as sets that the user can select using this API.

int vtkXdmfReader::GetSetStatus ( const char *  gridname)

Get/Set information about sets. As is typical with readers this is valid only after the filename as been set and UpdateInformation() has been called. Note that sets with non-zero Ghost value are not treated as sets that the user can select using this API.

int vtkXdmfReader::GetNumberOfSetArrays ( ) [inline]

These methods are provided to make it easier to use the Sets in ParaView.

Definition at line 124 of file vtkXdmfReader.h.

const char* vtkXdmfReader::GetSetArrayName ( int  index) [inline]

These methods are provided to make it easier to use the Sets in ParaView.

Definition at line 125 of file vtkXdmfReader.h.

int vtkXdmfReader::GetSetArrayStatus ( const char *  name) [inline]

These methods are provided to make it easier to use the Sets in ParaView.

Definition at line 127 of file vtkXdmfReader.h.

virtual void vtkXdmfReader::SetStride ( int  ,
int  ,
int   
) [virtual]

Get/Set the stride used to skip points when reading structured datasets. This affects all grids being read.

virtual void vtkXdmfReader::SetStride ( int  [3]) [virtual]

Get/Set the stride used to skip points when reading structured datasets. This affects all grids being read.

virtual int* vtkXdmfReader::GetStride ( ) [virtual]

Get/Set the stride used to skip points when reading structured datasets. This affects all grids being read.

virtual void vtkXdmfReader::GetStride ( int ,
int ,
int  
) [virtual]

Get/Set the stride used to skip points when reading structured datasets. This affects all grids being read.

virtual void vtkXdmfReader::GetStride ( int  [3]) [virtual]

Get/Set the stride used to skip points when reading structured datasets. This affects all grids being read.

virtual int vtkXdmfReader::CanReadFile ( const char *  filename) [virtual]

Determine if the file can be read with this reader.

virtual int vtkXdmfReader::GetSILUpdateStamp ( ) [virtual]

Every time the SIL is updated a this will return a different value.

virtual vtkGraph* vtkXdmfReader::GetSIL ( ) [virtual]

SIL describes organization of/relationships between classifications eg. blocks/materials/hierarchies.

virtual int vtkXdmfReader::ProcessRequest ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

Reimplemented from vtkDataReader.

virtual int vtkXdmfReader::RequestDataObject ( vtkInformationVector outputVector) [protected, virtual]
virtual int vtkXdmfReader::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkDataReader.

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

Reimplemented from vtkDataReader.

virtual int vtkXdmfReader::FillOutputPortInformation ( int  port,
vtkInformation info 
) [protected, virtual]

Reimplemented from vtkDataReader.

vtkXdmfArraySelection* vtkXdmfReader::GetPointArraySelection ( ) [protected]
vtkXdmfArraySelection* vtkXdmfReader::GetCellArraySelection ( ) [protected]
vtkXdmfArraySelection* vtkXdmfReader::GetGridSelection ( ) [protected]
vtkXdmfArraySelection* vtkXdmfReader::GetSetsSelection ( ) [protected]
void vtkXdmfReader::PassCachedSelections ( ) [protected]

Member Data Documentation

char* vtkXdmfReader::DomainName [protected]

Definition at line 171 of file vtkXdmfReader.h.

int vtkXdmfReader::Stride[3] [protected]

Definition at line 173 of file vtkXdmfReader.h.

unsigned int vtkXdmfReader::LastTimeIndex [protected]

Definition at line 174 of file vtkXdmfReader.h.

Definition at line 176 of file vtkXdmfReader.h.

Definition at line 187 of file vtkXdmfReader.h.

Definition at line 188 of file vtkXdmfReader.h.

Definition at line 189 of file vtkXdmfReader.h.

Definition at line 190 of file vtkXdmfReader.h.

Definition at line 192 of file vtkXdmfReader.h.


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