vtkTableExtentTranslator Class Reference

#include <vtkTableExtentTranslator.h>

Inheritance diagram for vtkTableExtentTranslator:

[legend]Collaboration diagram for vtkTableExtentTranslator:

[legend]List of all members.

---

Detailed Description

Extent translation through lookup table.

vtkTableExtentTranslator provides a vtkExtentTranslator that is programmed with a specific extent corresponding to each piece number. Readers can provide this to an application to allow the pipeline to execute using the same piece breakdown that is provided in the input file.

Definition at line 30 of file vtkTableExtentTranslator.h.

Public Types
typedef vtkExtentTranslator	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	PieceToExtent ()
void	SetNumberOfPieces (int pieces)
void	SetNumberOfPiecesInTable (int pieces)
virtual int	GetNumberOfPiecesInTable ()
int	PieceToExtentByPoints ()
int	PieceToExtentThreadSafe (int piece, int numPieces, int ghostLevel, int *wholeExtent, int *resultExtent, int splitMode, int byPoints)
virtual void	SetExtentForPiece (int piece, int *extent)
virtual void	GetExtentForPiece (int piece, int *extent)
virtual int *	GetExtentForPiece (int piece)
virtual void	SetMaximumGhostLevel (int)
virtual int	GetMaximumGhostLevel ()
virtual void	SetPieceAvailable (int piece, int available)
virtual int	GetPieceAvailable (int piece)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkTableExtentTranslator *	SafeDownCast (vtkObject *o)
static vtkTableExtentTranslator *	New ()
Protected Member Functions
	vtkTableExtentTranslator ()
	~vtkTableExtentTranslator ()
Protected Attributes
int *	ExtentTable
int	NumberOfPiecesInTable
int	MaximumGhostLevel
int *	PieceAvailable

---

Member Typedef Documentation

typedef vtkExtentTranslator vtkTableExtentTranslator::Superclass

Reimplemented from vtkExtentTranslator. Definition at line 33 of file vtkTableExtentTranslator.h.

---

Constructor & Destructor Documentation

vtkTableExtentTranslator::vtkTableExtentTranslator (   )  [protected]

vtkTableExtentTranslator::~vtkTableExtentTranslator (   )  [protected]

---

Member Function Documentation

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

Reimplemented from vtkExtentTranslator.

static int vtkTableExtentTranslator::IsTypeOf (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkExtentTranslator.

virtual int vtkTableExtentTranslator::IsA (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkExtentTranslator.

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

Reimplemented from vtkExtentTranslator.

void vtkTableExtentTranslator::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 vtkExtentTranslator.

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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkExtentTranslator.

void vtkTableExtentTranslator::SetNumberOfPieces (  int  pieces  )  [virtual]

Reimplemented from vtkExtentTranslator.

void vtkTableExtentTranslator::SetNumberOfPiecesInTable (  int  pieces  )

Set the real number of pieces in the extent table.

virtual int vtkTableExtentTranslator::GetNumberOfPiecesInTable (   )  [virtual]

int vtkTableExtentTranslator::PieceToExtent (   )  [virtual]

Called to translate the current piece into an extent. This is not thread safe. Reimplemented from vtkExtentTranslator.

int vtkTableExtentTranslator::PieceToExtentByPoints (   )  [virtual]

Not supported by this subclass of vtkExtentTranslator. Reimplemented from vtkExtentTranslator.

int vtkTableExtentTranslator::PieceToExtentThreadSafe (  int  piece, int  numPieces, int  ghostLevel, int *  wholeExtent, int *  resultExtent, int  splitMode, int  byPoints )  [virtual]

Not supported by this subclass of vtkExtentTranslator. Reimplemented from vtkExtentTranslator.

virtual void vtkTableExtentTranslator::SetExtentForPiece (  int  piece, int *  extent )  [virtual]

Set the extent to be used for a piece. This sets the extent table entry for the piece.

virtual void vtkTableExtentTranslator::GetExtentForPiece (  int  piece, int *  extent )  [virtual]

Get the extent table entry for the given piece. This is only for code that is setting up the table. Extent translation should always be done through the PieceToExtent method.

virtual int* vtkTableExtentTranslator::GetExtentForPiece (  int  piece  )  [virtual]

Set the extent to be used for a piece. This sets the extent table entry for the piece.

virtual void vtkTableExtentTranslator::SetMaximumGhostLevel (  int   )  [virtual]

Set the maximum ghost level that can be requested. This can be used by a reader to make sure an extent request does not go outside the boundaries of the piece's file.

virtual int vtkTableExtentTranslator::GetMaximumGhostLevel (   )  [virtual]

Set the maximum ghost level that can be requested. This can be used by a reader to make sure an extent request does not go outside the boundaries of the piece's file.

virtual void vtkTableExtentTranslator::SetPieceAvailable (  int  piece, int  available )  [virtual]

Get/Set whether the given piece is available. Requesting a piece that is not available will produce errors in the pipeline.

virtual int vtkTableExtentTranslator::GetPieceAvailable (  int  piece  )  [virtual]

Get/Set whether the given piece is available. Requesting a piece that is not available will produce errors in the pipeline.

---

Member Data Documentation

int* vtkTableExtentTranslator::ExtentTable [protected]

Definition at line 100 of file vtkTableExtentTranslator.h.

int vtkTableExtentTranslator::NumberOfPiecesInTable [protected]

Definition at line 101 of file vtkTableExtentTranslator.h.

int vtkTableExtentTranslator::MaximumGhostLevel [protected]

Definition at line 102 of file vtkTableExtentTranslator.h.

int* vtkTableExtentTranslator::PieceAvailable [protected]

Definition at line 105 of file vtkTableExtentTranslator.h.

---

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

• dox/Common/vtkTableExtentTranslator.h

---