VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkExtentSplitter Class Reference

Split an extent across other extents. More...

#include <vtkExtentSplitter.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkExtentSplitterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int ComputeSubExtents ()
 
int GetNumberOfSubExtents ()
 
int GetSubExtentSource (int index)
 
void AddExtentSource (int id, int priority, int x0, int x1, int y0, int y1, int z0, int z1)
 
void AddExtentSource (int id, int priority, int *extent)
 
void RemoveExtentSource (int id)
 
void RemoveAllExtentSources ()
 
void AddExtent (int x0, int x1, int y0, int y1, int z0, int z1)
 
void AddExtent (int *extent)
 
int * GetSubExtent (int index)
 
void GetSubExtent (int index, int *extent)
 
virtual int GetPointMode ()
 
virtual void SetPointMode (int)
 
virtual void PointModeOn ()
 
virtual void PointModeOff ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkExtentSplitterSafeDownCast (vtkObjectBase *o)
 
static vtkExtentSplitterNew ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkExtentSplitter ()
 
 ~vtkExtentSplitter ()
 
void SplitExtent (int *extent, int *subextent)
 
int IntersectExtents (const int *extent1, const int *extent2, int *result)
 
int Min (int a, int b)
 
int Max (int a, int b)
 

Protected Attributes

vtkExtentSplitterInternals * Internal
 
int PointMode
 

Detailed Description

Split an extent across other extents.

vtkExtentSplitter splits each input extent into non-overlapping sub-extents that are completely contained within other "source extents". A source extent corresponds to some resource providing an extent. Each source extent has an integer identifier, integer priority, and an extent. The input extents are split into sub-extents according to priority, availability, and amount of overlap of the source extents. This can be used by parallel data readers to read as few piece files as possible.

Definition at line 36 of file vtkExtentSplitter.h.

Member Typedef Documentation

typedef vtkObject vtkExtentSplitter::Superclass

Definition at line 39 of file vtkExtentSplitter.h.

Constructor & Destructor Documentation

vtkExtentSplitter::vtkExtentSplitter ( )
protected
vtkExtentSplitter::~vtkExtentSplitter ( )
protected

Member Function Documentation

static int vtkExtentSplitter::IsTypeOf ( const char *  type)
static
virtual int vtkExtentSplitter::IsA ( const char *  type)
virtual
static vtkExtentSplitter* vtkExtentSplitter::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkExtentSplitter::NewInstanceInternal ( ) const
protectedvirtual
vtkExtentSplitter* vtkExtentSplitter::NewInstance ( ) const
void vtkExtentSplitter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkExtentSplitter* vtkExtentSplitter::New ( )
static
void vtkExtentSplitter::AddExtentSource ( int  id,
int  priority,
int  x0,
int  x1,
int  y0,
int  y1,
int  z0,
int  z1 
)

Add/Remove a source providing the given extent. Sources with higher priority numbers are favored. Source id numbers and priorities must be non-negative.

void vtkExtentSplitter::AddExtentSource ( int  id,
int  priority,
int *  extent 
)

Add/Remove a source providing the given extent. Sources with higher priority numbers are favored. Source id numbers and priorities must be non-negative.

void vtkExtentSplitter::RemoveExtentSource ( int  id)

Add/Remove a source providing the given extent. Sources with higher priority numbers are favored. Source id numbers and priorities must be non-negative.

void vtkExtentSplitter::RemoveAllExtentSources ( )

Add/Remove a source providing the given extent. Sources with higher priority numbers are favored. Source id numbers and priorities must be non-negative.

void vtkExtentSplitter::AddExtent ( int  x0,
int  x1,
int  y0,
int  y1,
int  z0,
int  z1 
)

Add an extent to the queue of extents to be split among the available sources.

void vtkExtentSplitter::AddExtent ( int *  extent)

Add an extent to the queue of extents to be split among the available sources.

int vtkExtentSplitter::ComputeSubExtents ( )

Split the extents currently in the queue among the available sources. The queue is empty when this returns. Returns 1 if all extents could be read. Returns 0 if any portion of any extent was not available through any source.

int vtkExtentSplitter::GetNumberOfSubExtents ( )

Get the number of sub-extents into which the original set of extents have been split across the available sources. Valid after a call to ComputeSubExtents.

int* vtkExtentSplitter::GetSubExtent ( int  index)

Get the sub-extent associated with the given index. Use GetSubExtentSource to get the id of the source from which this sub-extent should be read. Valid after a call to ComputeSubExtents.

void vtkExtentSplitter::GetSubExtent ( int  index,
int *  extent 
)

Get the sub-extent associated with the given index. Use GetSubExtentSource to get the id of the source from which this sub-extent should be read. Valid after a call to ComputeSubExtents.

int vtkExtentSplitter::GetSubExtentSource ( int  index)

Get the id of the source from which the sub-extent associated with the given index should be read. Returns -1 if no source provides the sub-extent.

virtual int vtkExtentSplitter::GetPointMode ( )
virtual

Get/Set whether "point mode" is on. In point mode, sub-extents are generated to ensure every point in the update request is read, but not necessarily every cell. This can be used when point data are stored in a planar slice per piece with no cell data. The default is OFF.

virtual void vtkExtentSplitter::SetPointMode ( int  )
virtual

Get/Set whether "point mode" is on. In point mode, sub-extents are generated to ensure every point in the update request is read, but not necessarily every cell. This can be used when point data are stored in a planar slice per piece with no cell data. The default is OFF.

virtual void vtkExtentSplitter::PointModeOn ( )
virtual

Get/Set whether "point mode" is on. In point mode, sub-extents are generated to ensure every point in the update request is read, but not necessarily every cell. This can be used when point data are stored in a planar slice per piece with no cell data. The default is OFF.

virtual void vtkExtentSplitter::PointModeOff ( )
virtual

Get/Set whether "point mode" is on. In point mode, sub-extents are generated to ensure every point in the update request is read, but not necessarily every cell. This can be used when point data are stored in a planar slice per piece with no cell data. The default is OFF.

void vtkExtentSplitter::SplitExtent ( int *  extent,
int *  subextent 
)
protected
int vtkExtentSplitter::IntersectExtents ( const int *  extent1,
const int *  extent2,
int *  result 
)
protected
int vtkExtentSplitter::Min ( int  a,
int  b 
)
protected
int vtkExtentSplitter::Max ( int  a,
int  b 
)
protected

Member Data Documentation

vtkExtentSplitterInternals* vtkExtentSplitter::Internal
protected

Definition at line 107 of file vtkExtentSplitter.h.

int vtkExtentSplitter::PointMode
protected

Definition at line 112 of file vtkExtentSplitter.h.


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