vtkXdmfDomain Class Reference

#include <vtkXdmfReaderInternal.h>

Public Member Functions
	vtkXdmfDomain (xdmf2::XdmfDOM *xmlDom, int domain_index)
bool	IsValid ()
	After instantiating, check that the domain is valid.
vtkGraph *	GetSIL ()
XdmfInt64	GetNumberOfGrids ()
	Returns the number of top-level grids present in this domain.
xdmf2::XdmfGrid *	GetGrid (XdmfInt64 cc)
	Provides access to a top-level grid from this domain.
int	GetVTKDataType ()
	Returns the VTK data type need for this domain.
const std::map< XdmfFloat64, int > &	GetTimeSteps ()
	Returns the timesteps.
const std::map< int, XdmfFloat64 > &	GetTimeStepsRev ()
int	GetIndexForTime (double time)
	Given a time value, returns the index.
xdmf2::XdmfGrid *	GetGrid (xdmf2::XdmfGrid *xmfGrid, double time)
	If xmfGrid is a temporal collection, returns the child-grid matching the requested time.
bool	IsStructured (xdmf2::XdmfGrid *)
	Returns true if the grids is a structured dataset.
bool	GetWholeExtent (xdmf2::XdmfGrid *, int extents[6])
	Returns the whole extents for the dataset if the grid if IsStructured() returns true for the given grid.
bool	GetOriginAndSpacing (xdmf2::XdmfGrid *, double origin[3], double spacing[3])
	Returns the spacing and origin for the grid if the grid topology == XDMF_2DCORECTMESH or XDMF_3DCORECTMESH i.e.
	~vtkXdmfDomain ()
int	GetVTKDataType (xdmf2::XdmfGrid *xmfGrid)
vtkXdmfArraySelection *	GetPointArraySelection ()
vtkXdmfArraySelection *	GetCellArraySelection ()
vtkXdmfArraySelection *	GetGridSelection ()
vtkXdmfArraySelection *	GetSetsSelection ()
XdmfFloat64	GetTimeForIndex (int index)
	Returns the time value at the given index.

Static Public Member Functions
static int	GetDataDimensionality (xdmf2::XdmfGrid *xmfGrid)

Detailed Description

Definition at line 169 of file vtkXdmfReaderInternal.h.

Constructor & Destructor Documentation

vtkXdmfDomain()

vtkXdmfDomain::vtkXdmfDomain	(	xdmf2::XdmfDOM *	xmlDom,
		int	domain_index
	)

~vtkXdmfDomain()

vtkXdmfDomain::~vtkXdmfDomain

(

)

Member Function Documentation

IsValid()

bool vtkXdmfDomain::IsValid ( )

inline

After instantiating, check that the domain is valid.

If this returns false, it means that the specified domain could not be located.

Definition at line 205 of file vtkXdmfReaderInternal.h.

GetSIL()

vtkGraph * vtkXdmfDomain::GetSIL ( )

inline

Definition at line 208 of file vtkXdmfReaderInternal.h.

GetNumberOfGrids()

XdmfInt64 vtkXdmfDomain::GetNumberOfGrids ( )

inline

Returns the number of top-level grids present in this domain.

Definition at line 214 of file vtkXdmfReaderInternal.h.

GetGrid() [1/2]

xdmf2::XdmfGrid * vtkXdmfDomain::GetGrid

(

XdmfInt64

cc

)

Provides access to a top-level grid from this domain.

GetVTKDataType() [1/2]

int vtkXdmfDomain::GetVTKDataType

(

)

Returns the VTK data type need for this domain.

If the domain has only 1 grid, then a vtkDataSet-type is returned, otherwise a vtkMultiBlockDataSet is required. Returns -1 on error.

GetTimeSteps()

const std::map< XdmfFloat64, int > & vtkXdmfDomain::GetTimeSteps ( )

inline

Returns the timesteps.

Definition at line 235 of file vtkXdmfReaderInternal.h.

GetTimeStepsRev()

const std::map< int, XdmfFloat64 > & vtkXdmfDomain::GetTimeStepsRev ( )

inline

Definition at line 236 of file vtkXdmfReaderInternal.h.

GetIndexForTime()

int vtkXdmfDomain::GetIndexForTime

(

double

time

)

Given a time value, returns the index.

GetTimeForIndex()

XdmfFloat64 vtkXdmfDomain::GetTimeForIndex ( int  index )

inline

Returns the time value at the given index.

Definition at line 249 of file vtkXdmfReaderInternal.h.

GetGrid() [2/2]

xdmf2::XdmfGrid * vtkXdmfDomain::GetGrid	(	xdmf2::XdmfGrid *	xmfGrid,
		double	time
	)

If xmfGrid is a temporal collection, returns the child-grid matching the requested time.

IsStructured()

bool vtkXdmfDomain::IsStructured

(

xdmf2::XdmfGrid *

)

Returns true if the grids is a structured dataset.

GetWholeExtent()

bool vtkXdmfDomain::GetWholeExtent	(	xdmf2::XdmfGrid *	,
		int	extents[6]
	)

Returns the whole extents for the dataset if the grid if IsStructured() returns true for the given grid.

Returns true if the extents are valid. NOTE: returned extents are always (0, dimx-1, 0, dimy-1, 0, dimz-1).

GetOriginAndSpacing()

bool vtkXdmfDomain::GetOriginAndSpacing	(	xdmf2::XdmfGrid *	,
		double	origin[3],
		double	spacing[3]
	)

Returns the spacing and origin for the grid if the grid topology == XDMF_2DCORECTMESH or XDMF_3DCORECTMESH i.e.

image data. Returns true if the extents are valid.

GetVTKDataType() [2/2]

int vtkXdmfDomain::GetVTKDataType

(

xdmf2::XdmfGrid *

xmfGrid

)

GetDataDimensionality()

static int vtkXdmfDomain::GetDataDimensionality ( xdmf2::XdmfGrid *  xmfGrid )

static

GetPointArraySelection()

vtkXdmfArraySelection * vtkXdmfDomain::GetPointArraySelection ( )

inline

Definition at line 296 of file vtkXdmfReaderInternal.h.

GetCellArraySelection()

vtkXdmfArraySelection * vtkXdmfDomain::GetCellArraySelection ( )

inline

Definition at line 297 of file vtkXdmfReaderInternal.h.

GetGridSelection()

vtkXdmfArraySelection * vtkXdmfDomain::GetGridSelection ( )

inline

Definition at line 298 of file vtkXdmfReaderInternal.h.

GetSetsSelection()

vtkXdmfArraySelection * vtkXdmfDomain::GetSetsSelection ( )

inline

Definition at line 299 of file vtkXdmfReaderInternal.h.

---

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

• IO/Xdmf2/vtkXdmfReaderInternal.h