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
vtkTableExtentTranslator Class Reference

Extent translation through lookup table. More...

#include <vtkTableExtentTranslator.h>

Inheritance diagram for vtkTableExtentTranslator:
[legend]
Collaboration diagram for vtkTableExtentTranslator:
[legend]

Public Types

typedef vtkExtentTranslator Superclass
 
- Public Types inherited from vtkExtentTranslator
typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkTableExtentTranslatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetNumberOfPieces (int pieces)
 
int PieceToExtent ()
 
int PieceToExtentByPoints ()
 
virtual void SetExtentForPiece (int piece, int *extent)
 
void SetNumberOfPiecesInTable (int pieces)
 
virtual int GetNumberOfPiecesInTable ()
 
int PieceToExtentThreadSafe (int piece, int numPieces, int ghostLevel, int *wholeExtent, int *resultExtent, int splitMode, int byPoints)
 
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)
 
- Public Member Functions inherited from vtkExtentTranslator
vtkExtentTranslatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetSplitPath (int len, int *splitpath)
 
virtual void SetWholeExtent (int, int, int, int, int, int)
 
virtual void SetWholeExtent (int[6])
 
virtual int * GetWholeExtent ()
 
virtual void GetWholeExtent (int &, int &, int &, int &, int &, int &)
 
virtual void GetWholeExtent (int[6])
 
virtual void SetExtent (int, int, int, int, int, int)
 
virtual void SetExtent (int[6])
 
virtual int * GetExtent ()
 
virtual void GetExtent (int &, int &, int &, int &, int &, int &)
 
virtual void GetExtent (int[6])
 
virtual void SetPiece (int)
 
virtual int GetPiece ()
 
virtual int GetNumberOfPieces ()
 
virtual void SetGhostLevel (int)
 
virtual int GetGhostLevel ()
 
void SetSplitModeToBlock ()
 
void SetSplitModeToXSlab ()
 
void SetSplitModeToYSlab ()
 
void SetSplitModeToZSlab ()
 
virtual int GetSplitMode ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkTableExtentTranslatorSafeDownCast (vtkObjectBase *o)
 
static vtkTableExtentTranslatorNew ()
 
- Static Public Member Functions inherited from vtkExtentTranslator
static vtkExtentTranslatorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkExtentTranslatorSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkTableExtentTranslator ()
 
 ~vtkTableExtentTranslator ()
 
- Protected Member Functions inherited from vtkExtentTranslator
 vtkExtentTranslator ()
 
 ~vtkExtentTranslator ()
 
int SplitExtent (int piece, int numPieces, int *extent, int splitMode)
 
int SplitExtentByPoints (int piece, int numPieces, int *extent, int splitMode)
 

Protected Attributes

int * ExtentTable
 
int NumberOfPiecesInTable
 
int MaximumGhostLevel
 
int * PieceAvailable
 
- Protected Attributes inherited from vtkExtentTranslator
int Piece
 
int NumberOfPieces
 
int GhostLevel
 
int Extent [6]
 
int WholeExtent [6]
 
int SplitMode
 
int * SplitPath
 
int SplitLen
 

Additional Inherited Members

- Protected Types inherited from vtkExtentTranslator
enum  Modes { X_SLAB_MODE =0, Y_SLAB_MODE =1, Z_SLAB_MODE =2, BLOCK_MODE = 3 }
 

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 31 of file vtkTableExtentTranslator.h.

Member Typedef Documentation

Definition at line 34 of file vtkTableExtentTranslator.h.

Constructor & Destructor Documentation

vtkTableExtentTranslator::vtkTableExtentTranslator ( )
protected
vtkTableExtentTranslator::~vtkTableExtentTranslator ( )
protected

Member Function Documentation

static int vtkTableExtentTranslator::IsTypeOf ( const char *  type)
static
virtual int vtkTableExtentTranslator::IsA ( const char *  type)
virtual

Reimplemented from vtkExtentTranslator.

static vtkTableExtentTranslator* vtkTableExtentTranslator::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkTableExtentTranslator::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkExtentTranslator.

vtkTableExtentTranslator* vtkTableExtentTranslator::NewInstance ( ) const
void vtkTableExtentTranslator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkTableExtentTranslator* vtkTableExtentTranslator::New ( )
static
void vtkTableExtentTranslator::SetNumberOfPieces ( int  )
virtual

Set the Piece/NumPieces. Set the WholeExtent and then call PieceToExtent. The result can be obtained from the Extent ivar.

Reimplemented from vtkExtentTranslator.

void vtkTableExtentTranslator::SetNumberOfPiecesInTable ( int  pieces)

Set the real number of pieces in the extent table.

virtual int vtkTableExtentTranslator::GetNumberOfPiecesInTable ( )
virtual

Set the real number of pieces in the extent table.

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

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 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 101 of file vtkTableExtentTranslator.h.

int vtkTableExtentTranslator::NumberOfPiecesInTable
protected

Definition at line 102 of file vtkTableExtentTranslator.h.

int vtkTableExtentTranslator::MaximumGhostLevel
protected

Definition at line 103 of file vtkTableExtentTranslator.h.

int* vtkTableExtentTranslator::PieceAvailable
protected

Definition at line 106 of file vtkTableExtentTranslator.h.


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