VTK
Public Member Functions | Static Public Member Functions | List of all members
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. More...
 
vtkGraphGetSIL ()
 
XdmfInt64 GetNumberOfGrids ()
 Returns the number of top-level grids present in this domain. More...
 
xdmf2::XdmfGrid * GetGrid (XdmfInt64 cc)
 Provides access to a top-level grid from this domain. More...
 
int GetVTKDataType ()
 Returns the VTK data type need for this domain. More...
 
const std::map< XdmfFloat64, int > & GetTimeSteps ()
 Returns the timesteps. More...
 
const std::map< int, XdmfFloat64 > & GetTimeStepsRev ()
 
int GetIndexForTime (double time)
 Given a time value, returns the index. More...
 
xdmf2::XdmfGrid * GetGrid (xdmf2::XdmfGrid *xmfGrid, double time)
 If xmfGrid is a temporal collection, returns the child-grid matching the requested time. More...
 
bool IsStructured (xdmf2::XdmfGrid *)
 Returns true if the grids is a structured dataset. More...
 
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. More...
 
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. More...
 
 ~vtkXdmfDomain ()
 
int GetVTKDataType (xdmf2::XdmfGrid *xmfGrid)
 
vtkXdmfArraySelectionGetPointArraySelection ()
 
vtkXdmfArraySelectionGetCellArraySelection ()
 
vtkXdmfArraySelectionGetGridSelection ()
 
vtkXdmfArraySelectionGetSetsSelection ()
 
XdmfFloat64 GetTimeForIndex (int index)
 Returns the time value at the given index. More...
 

Static Public Member Functions

static int GetDataDimensionality (xdmf2::XdmfGrid *xmfGrid)
 

Detailed Description

Definition at line 198 of file vtkXdmfReaderInternal.h.

Constructor & Destructor Documentation

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

Member Function Documentation

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 235 of file vtkXdmfReaderInternal.h.

vtkGraph* vtkXdmfDomain::GetSIL ( )
inline

Definition at line 239 of file vtkXdmfReaderInternal.h.

XdmfInt64 vtkXdmfDomain::GetNumberOfGrids ( )
inline

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

Definition at line 246 of file vtkXdmfReaderInternal.h.

xdmf2::XdmfGrid* vtkXdmfDomain::GetGrid ( XdmfInt64  cc)

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

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.

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

Returns the timesteps.

Definition at line 267 of file vtkXdmfReaderInternal.h.

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

Definition at line 269 of file vtkXdmfReaderInternal.h.

int vtkXdmfDomain::GetIndexForTime ( double  time)

Given a time value, returns the index.

XdmfFloat64 vtkXdmfDomain::GetTimeForIndex ( int  index)
inline

Returns the time value at the given index.

Definition at line 283 of file vtkXdmfReaderInternal.h.

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

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

bool vtkXdmfDomain::IsStructured ( xdmf2::XdmfGrid *  )

Returns true if the grids is a structured dataset.

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

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.

int vtkXdmfDomain::GetVTKDataType ( xdmf2::XdmfGrid *  xmfGrid)
static int vtkXdmfDomain::GetDataDimensionality ( xdmf2::XdmfGrid *  xmfGrid)
static
vtkXdmfArraySelection* vtkXdmfDomain::GetPointArraySelection ( )
inline

Definition at line 330 of file vtkXdmfReaderInternal.h.

vtkXdmfArraySelection* vtkXdmfDomain::GetCellArraySelection ( )
inline

Definition at line 332 of file vtkXdmfReaderInternal.h.

vtkXdmfArraySelection* vtkXdmfDomain::GetGridSelection ( )
inline

Definition at line 334 of file vtkXdmfReaderInternal.h.

vtkXdmfArraySelection* vtkXdmfDomain::GetSetsSelection ( )
inline

Definition at line 336 of file vtkXdmfReaderInternal.h.


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