ParaView
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>

Inherits vtkExtentTranslator.

Public Types

typedef vtkExtentTranslator Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetNumberOfPieces (int pieces)
 
int PieceToExtent ()
 Called to translate the current piece into an extent. More...
 
int PieceToExtentByPoints ()
 Not supported by this subclass of vtkExtentTranslator. More...
 
int PieceToExtentThreadSafe (int piece, int numPieces, int ghostLevel, int *wholeExtent, int *resultExtent, int splitMode, int byPoints)
 Not supported by this subclass of vtkExtentTranslator. More...
 
virtual void SetExtentForPiece (int piece, int *extent)
 Set the extent to be used for a piece. More...
 
void SetNumberOfPiecesInTable (int pieces)
 Set the real number of pieces in the extent table. More...
 
virtual int GetNumberOfPiecesInTable ()
 Set the real number of pieces in the extent table. More...
 
virtual void GetExtentForPiece (int piece, int *extent)
 Get the extent table entry for the given piece. More...
 
virtual int * GetExtentForPiece (int piece)
 Get the extent table entry for the given piece. More...
 
virtual void SetMaximumGhostLevel (int)
 Set the maximum ghost level that can be requested. More...
 
virtual int GetMaximumGhostLevel ()
 Set the maximum ghost level that can be requested. More...
 
virtual void SetPieceAvailable (int piece, int available)
 Get/Set whether the given piece is available. More...
 
virtual int GetPieceAvailable (int piece)
 Get/Set whether the given piece is available. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkTableExtentTranslatorSafeDownCast (vtkObject *o)
 
static vtkTableExtentTranslatorNew ()
 

Protected Member Functions

 vtkTableExtentTranslator ()
 
 ~vtkTableExtentTranslator ()
 

Protected Attributes

int * ExtentTable
 
int NumberOfPiecesInTable
 
int MaximumGhostLevel
 
int * PieceAvailable
 

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

Member Typedef Documentation

◆ Superclass

typedef vtkExtentTranslator vtkTableExtentTranslator::Superclass

Definition at line 35 of file vtkTableExtentTranslator.h.

Constructor & Destructor Documentation

◆ vtkTableExtentTranslator()

vtkTableExtentTranslator::vtkTableExtentTranslator ( )
protected

◆ ~vtkTableExtentTranslator()

vtkTableExtentTranslator::~vtkTableExtentTranslator ( )
protected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkTableExtentTranslator::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkTableExtentTranslator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ New()

static vtkTableExtentTranslator* vtkTableExtentTranslator::New ( )
static

◆ SetNumberOfPieces()

void vtkTableExtentTranslator::SetNumberOfPieces ( int  pieces)

◆ SetNumberOfPiecesInTable()

void vtkTableExtentTranslator::SetNumberOfPiecesInTable ( int  pieces)

Set the real number of pieces in the extent table.

◆ GetNumberOfPiecesInTable()

virtual int vtkTableExtentTranslator::GetNumberOfPiecesInTable ( )
virtual

Set the real number of pieces in the extent table.

◆ PieceToExtent()

int vtkTableExtentTranslator::PieceToExtent ( )

Called to translate the current piece into an extent.

This is not thread safe.

◆ PieceToExtentByPoints()

int vtkTableExtentTranslator::PieceToExtentByPoints ( )

Not supported by this subclass of vtkExtentTranslator.

◆ PieceToExtentThreadSafe()

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

Not supported by this subclass of vtkExtentTranslator.

◆ SetExtentForPiece()

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.

◆ GetExtentForPiece() [1/2]

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.

◆ GetExtentForPiece() [2/2]

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.

◆ SetMaximumGhostLevel()

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.

◆ GetMaximumGhostLevel()

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.

◆ SetPieceAvailable()

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.

◆ GetPieceAvailable()

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

◆ ExtentTable

int* vtkTableExtentTranslator::ExtentTable
protected

Definition at line 113 of file vtkTableExtentTranslator.h.

◆ NumberOfPiecesInTable

int vtkTableExtentTranslator::NumberOfPiecesInTable
protected

Definition at line 114 of file vtkTableExtentTranslator.h.

◆ MaximumGhostLevel

int vtkTableExtentTranslator::MaximumGhostLevel
protected

Definition at line 115 of file vtkTableExtentTranslator.h.

◆ PieceAvailable

int* vtkTableExtentTranslator::PieceAvailable
protected

Definition at line 118 of file vtkTableExtentTranslator.h.


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