Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkStreamingDemandDrivenPipeline Class Reference

#include <vtkStreamingDemandDrivenPipeline.h>

Inheritance diagram for vtkStreamingDemandDrivenPipeline:

Inheritance graph
[legend]
Collaboration diagram for vtkStreamingDemandDrivenPipeline:

Collaboration graph
[legend]
List of all members.

Detailed Description

Executive supporting partial updates.

vtkStreamingDemandDrivenPipeline is an executive that supports updating only a portion of the data set in the pipeline. This is the style of pipeline update that is provided by the old-style VTK 4.x pipeline. Instead of always updating an entire data set, this executive supports asking for pieces or sub-extents.

Examples:
vtkStreamingDemandDrivenPipeline (Examples)
Tests:
vtkStreamingDemandDrivenPipeline (Tests)

Definition at line 42 of file vtkStreamingDemandDrivenPipeline.h.

Public Types

typedef vtkDemandDrivenPipeline Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
virtual int Update ()
virtual int Update (int port)
virtual int UpdateWholeExtent ()
int PropagateUpdateExtent (int outputPort)
int SetMaximumNumberOfPieces (vtkInformation *, int n)
int GetMaximumNumberOfPieces (vtkInformation *)
int SetWholeExtent (vtkInformation *, int extent[6])
void GetWholeExtent (vtkInformation *, int extent[6])
int * GetWholeExtent (vtkInformation *)
int SetUpdateExtentToWholeExtent (vtkInformation *)
int SetUpdateExtent (vtkInformation *, int extent[6])
void GetUpdateExtent (vtkInformation *, int extent[6])
int * GetUpdateExtent (vtkInformation *)
int SetUpdateExtent (vtkInformation *, int piece, int numPieces, int ghostLevel)
int SetUpdatePiece (vtkInformation *, int piece)
int GetUpdatePiece (vtkInformation *)
int SetUpdateNumberOfPieces (vtkInformation *, int n)
int GetUpdateNumberOfPieces (vtkInformation *)
int SetUpdateGhostLevel (vtkInformation *, int n)
int GetUpdateGhostLevel (vtkInformation *)
int SetRequestExactExtent (int port, int flag)
int GetRequestExactExtent (int port)
int SetExtentTranslator (vtkInformation *, vtkExtentTranslator *translator)
vtkExtentTranslator * GetExtentTranslator (vtkInformation *info)
int SetWholeBoundingBox (int port, double bb[6])
void GetWholeBoundingBox (int port, double bb[6])
double * GetWholeBoundingBox (int port)

Static Public Member Functions

static vtkStreamingDemandDrivenPipeline * New ()
static int IsTypeOf (const char *type)
static vtkStreamingDemandDrivenPipeline * SafeDownCast (vtkObject *o)
static vtkInformationRequestKey * REQUEST_UPDATE_EXTENT ()
static vtkInformationIntegerKey * CONTINUE_EXECUTING ()
static vtkInformationIntegerVectorKey * WHOLE_EXTENT ()
static vtkInformationIntegerKey * MAXIMUM_NUMBER_OF_PIECES ()
static vtkInformationDoubleVectorKey * WHOLE_BOUNDING_BOX ()
static vtkInformationIntegerKey * EXACT_EXTENT ()
static vtkInformationDoubleVectorKey * TIME_STEPS ()
static vtkInformationIntegerKey * UPDATE_TIME_INDEX ()
static vtkInformationObjectBaseKey * EXTENT_TRANSLATOR ()
static vtkInformationIntegerKey * UPDATE_EXTENT_INITIALIZED ()
static vtkInformationIntegerVectorKey * UPDATE_EXTENT ()
static vtkInformationIntegerKey * UPDATE_PIECE_NUMBER ()
static vtkInformationIntegerKey * UPDATE_NUMBER_OF_PIECES ()
static vtkInformationIntegerKey * UPDATE_NUMBER_OF_GHOST_LEVELS ()

Protected Member Functions

 vtkStreamingDemandDrivenPipeline ()
 ~vtkStreamingDemandDrivenPipeline ()
virtual int ExecuteInformation (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
virtual void CopyDefaultInformation (vtkInformation *request, int direction, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
virtual int VerifyOutputInformation (int outputPort, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
virtual int NeedToExecuteData (int outputPort, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
virtual void ExecuteDataStart (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
virtual void ExecuteDataEnd (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
virtual void MarkOutputsGenerated (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
virtual void ResetPipelineInformation (int port, vtkInformation *)

Protected Attributes

int ContinueExecuting
vtkInformation * UpdateExtentRequest
int LastPropogateUpdateExtentShortCircuited

Member Typedef Documentation

typedef vtkDemandDrivenPipeline vtkStreamingDemandDrivenPipeline::Superclass
 

Reimplemented from vtkDemandDrivenPipeline.

Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkCompositeDataPipeline, and vtkImageImportExecutive.

Definition at line 46 of file vtkStreamingDemandDrivenPipeline.h.

Constructor & Destructor Documentation

vtkStreamingDemandDrivenPipeline::vtkStreamingDemandDrivenPipeline (   )  [protected]
 

vtkStreamingDemandDrivenPipeline::~vtkStreamingDemandDrivenPipeline (   )  [protected]
 

Member Function Documentation

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

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

Reimplemented from vtkDemandDrivenPipeline.

Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkCompositeDataPipeline, and vtkImageImportExecutive.

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

Reimplemented from vtkDemandDrivenPipeline.

Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkCompositeDataPipeline, and vtkImageImportExecutive.

static int vtkStreamingDemandDrivenPipeline::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 vtkDemandDrivenPipeline.

Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkCompositeDataPipeline, and vtkImageImportExecutive.

virtual int vtkStreamingDemandDrivenPipeline::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 vtkDemandDrivenPipeline.

Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkCompositeDataPipeline, and vtkImageImportExecutive.

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

Reimplemented from vtkDemandDrivenPipeline.

Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkCompositeDataPipeline, and vtkImageImportExecutive.

void vtkStreamingDemandDrivenPipeline::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 vtkDemandDrivenPipeline.

Reimplemented in vtkCachedStreamingDemandDrivenPipeline, and vtkCompositeDataPipeline.

virtual int vtkStreamingDemandDrivenPipeline::ProcessRequest (  vtkInformation *  request,
vtkInformationVector **  inInfo,
vtkInformationVector *  outInfo
)  [virtual]
 

Generalized interface for asking the executive to fullfill update requests.

Reimplemented from vtkDemandDrivenPipeline.

Reimplemented in vtkCompositeDataPipeline, and vtkImageImportExecutive.

virtual int vtkStreamingDemandDrivenPipeline::Update (   )  [virtual]
 

Bring the outputs up-to-date.

Reimplemented from vtkDemandDrivenPipeline.

Reimplemented in vtkCachedStreamingDemandDrivenPipeline.

virtual int vtkStreamingDemandDrivenPipeline::Update (  int  port  )  [virtual]
 

Bring the outputs up-to-date.

Reimplemented from vtkDemandDrivenPipeline.

Reimplemented in vtkCachedStreamingDemandDrivenPipeline.

virtual int vtkStreamingDemandDrivenPipeline::UpdateWholeExtent (   )  [virtual]
 

Bring the outputs up-to-date.

int vtkStreamingDemandDrivenPipeline::PropagateUpdateExtent (  int  outputPort  ) 
 

Propagate the update request from the given output port back through the pipeline. Should be called only when information is up to date.

int vtkStreamingDemandDrivenPipeline::SetMaximumNumberOfPieces (  vtkInformation *  ,
int  n
) 
 

Set/Get the maximum number of pieces that can be requested from the given port. The maximum number of pieces is meta data for unstructured data sets. It gets set by the source during the update information call. A value of -1 indicates that there is no maximum.

int vtkStreamingDemandDrivenPipeline::GetMaximumNumberOfPieces (  vtkInformation *   ) 
 

Propagate the update request from the given output port back through the pipeline. Should be called only when information is up to date.

int vtkStreamingDemandDrivenPipeline::SetWholeExtent (  vtkInformation *  ,
int  extent[6]
) 
 

Set/Get the whole extent of an output port. The whole extent is meta data for structured data sets. It gets set by the algorithm during the update information pass.

void vtkStreamingDemandDrivenPipeline::GetWholeExtent (  vtkInformation *  ,
int  extent[6]
) 
 

Set/Get the whole extent of an output port. The whole extent is meta data for structured data sets. It gets set by the algorithm during the update information pass.

int* vtkStreamingDemandDrivenPipeline::GetWholeExtent (  vtkInformation *   ) 
 

Set/Get the whole extent of an output port. The whole extent is meta data for structured data sets. It gets set by the algorithm during the update information pass.

int vtkStreamingDemandDrivenPipeline::SetUpdateExtentToWholeExtent (  vtkInformation *   ) 
 

If the whole input extent is required to generate the requested output extent, this method can be called to set the input update extent to the whole input extent. This method assumes that the whole extent is known (that UpdateInformation has been called)

int vtkStreamingDemandDrivenPipeline::SetUpdateExtent (  vtkInformation *  ,
int  extent[6]
) 
 

Get/Set the update extent for output ports that use 3D extents.

void vtkStreamingDemandDrivenPipeline::GetUpdateExtent (  vtkInformation *  ,
int  extent[6]
) 
 

If the whole input extent is required to generate the requested output extent, this method can be called to set the input update extent to the whole input extent. This method assumes that the whole extent is known (that UpdateInformation has been called)

int* vtkStreamingDemandDrivenPipeline::GetUpdateExtent (  vtkInformation *   ) 
 

If the whole input extent is required to generate the requested output extent, this method can be called to set the input update extent to the whole input extent. This method assumes that the whole extent is known (that UpdateInformation has been called)

int vtkStreamingDemandDrivenPipeline::SetUpdateExtent (  vtkInformation *  ,
int  piece,
int  numPieces,
int  ghostLevel
) 
 

Set/Get the update piece, update number of pieces, and update number of ghost levels for an output port. Similar to update extent in 3D.

int vtkStreamingDemandDrivenPipeline::SetUpdatePiece (  vtkInformation *  ,
int  piece
) 
 

Set/Get the update piece, update number of pieces, and update number of ghost levels for an output port. Similar to update extent in 3D.

int vtkStreamingDemandDrivenPipeline::GetUpdatePiece (  vtkInformation *   ) 
 

Set/Get the update piece, update number of pieces, and update number of ghost levels for an output port. Similar to update extent in 3D.

int vtkStreamingDemandDrivenPipeline::SetUpdateNumberOfPieces (  vtkInformation *  ,
int  n
) 
 

Set/Get the update piece, update number of pieces, and update number of ghost levels for an output port. Similar to update extent in 3D.

int vtkStreamingDemandDrivenPipeline::GetUpdateNumberOfPieces (  vtkInformation *   ) 
 

Set/Get the update piece, update number of pieces, and update number of ghost levels for an output port. Similar to update extent in 3D.

int vtkStreamingDemandDrivenPipeline::SetUpdateGhostLevel (  vtkInformation *  ,
int  n
) 
 

Set/Get the update piece, update number of pieces, and update number of ghost levels for an output port. Similar to update extent in 3D.

int vtkStreamingDemandDrivenPipeline::GetUpdateGhostLevel (  vtkInformation *   ) 
 

Set/Get the update piece, update number of pieces, and update number of ghost levels for an output port. Similar to update extent in 3D.

int vtkStreamingDemandDrivenPipeline::SetRequestExactExtent (  int  port,
int  flag
) 
 

This request flag indicates whether the requester can handle more data than requested for the given port. Right now it is used in vtkImageData. Image filters can return more data than requested. The the consumer cannot handle this (i.e. DataSetToDataSetFitler) the image will crop itself. This functionality used to be in ImageToStructuredPoints.

int vtkStreamingDemandDrivenPipeline::GetRequestExactExtent (  int  port  ) 
 

This request flag indicates whether the requester can handle more data than requested for the given port. Right now it is used in vtkImageData. Image filters can return more data than requested. The the consumer cannot handle this (i.e. DataSetToDataSetFitler) the image will crop itself. This functionality used to be in ImageToStructuredPoints.

int vtkStreamingDemandDrivenPipeline::SetExtentTranslator (  vtkInformation *  ,
vtkExtentTranslator *  translator
) 
 

Get/Set the object that will translate pieces into structured extents for an output port.

vtkExtentTranslator* vtkStreamingDemandDrivenPipeline::GetExtentTranslator (  vtkInformation *  info  ) 
 

Get/Set the object that will translate pieces into structured extents for an output port.

int vtkStreamingDemandDrivenPipeline::SetWholeBoundingBox (  int  port,
double  bb[6]
) 
 

Set/Get the whole bounding box of an output port data object. The whole whole bounding box is meta data for data sets. It gets set by the algorithm during the update information pass.

void vtkStreamingDemandDrivenPipeline::GetWholeBoundingBox (  int  port,
double  bb[6]
) 
 

Set/Get the whole bounding box of an output port data object. The whole whole bounding box is meta data for data sets. It gets set by the algorithm during the update information pass.

double* vtkStreamingDemandDrivenPipeline::GetWholeBoundingBox (  int  port  ) 
 

Set/Get the whole bounding box of an output port data object. The whole whole bounding box is meta data for data sets. It gets set by the algorithm during the update information pass.

static vtkInformationRequestKey* vtkStreamingDemandDrivenPipeline::REQUEST_UPDATE_EXTENT (   )  [static]
 

Key defining a request to propagate the update extent upstream.

static vtkInformationIntegerKey* vtkStreamingDemandDrivenPipeline::CONTINUE_EXECUTING (   )  [static]
 

Key for an algorithm to store in a request to tell this executive to keep executing it.

static vtkInformationObjectBaseKey* vtkStreamingDemandDrivenPipeline::EXTENT_TRANSLATOR (   )  [static]
 

Key to store an extent translator in pipeline information.

static vtkInformationIntegerKey* vtkStreamingDemandDrivenPipeline::UPDATE_EXTENT_INITIALIZED (   )  [static]
 

Keys to store an update request in pipeline information.

static vtkInformationIntegerVectorKey* vtkStreamingDemandDrivenPipeline::UPDATE_EXTENT (   )  [static]
 

Key to store an extent translator in pipeline information.

static vtkInformationIntegerKey* vtkStreamingDemandDrivenPipeline::UPDATE_PIECE_NUMBER (   )  [static]
 

Key to store an extent translator in pipeline information.

static vtkInformationIntegerKey* vtkStreamingDemandDrivenPipeline::UPDATE_NUMBER_OF_PIECES (   )  [static]
 

Key to store an extent translator in pipeline information.

static vtkInformationIntegerKey* vtkStreamingDemandDrivenPipeline::UPDATE_NUMBER_OF_GHOST_LEVELS (   )  [static]
 

Key to store an extent translator in pipeline information.

static vtkInformationIntegerVectorKey* vtkStreamingDemandDrivenPipeline::WHOLE_EXTENT (   )  [static]
 

Key to store the whole extent provided in pipeline information.

static vtkInformationIntegerKey* vtkStreamingDemandDrivenPipeline::MAXIMUM_NUMBER_OF_PIECES (   )  [static]
 

Key to store the maximum number of pieces provided in pipeline information.

static vtkInformationDoubleVectorKey* vtkStreamingDemandDrivenPipeline::WHOLE_BOUNDING_BOX (   )  [static]
 

Key to store the bounding box of the entire data set in pipeline information.

static vtkInformationIntegerKey* vtkStreamingDemandDrivenPipeline::EXACT_EXTENT (   )  [static]
 

Key to specify the request for exact extent in pipeline information.

static vtkInformationDoubleVectorKey* vtkStreamingDemandDrivenPipeline::TIME_STEPS (   )  [static]
 

Key to store available time steps.

static vtkInformationIntegerKey* vtkStreamingDemandDrivenPipeline::UPDATE_TIME_INDEX (   )  [static]
 

Update time requested by the pipeline.

virtual int vtkStreamingDemandDrivenPipeline::ExecuteInformation (  vtkInformation *  request,
vtkInformationVector **  inInfoVec,
vtkInformationVector *  outInfoVec
)  [protected, virtual]
 

Reimplemented from vtkDemandDrivenPipeline.

virtual void vtkStreamingDemandDrivenPipeline::CopyDefaultInformation (  vtkInformation *  request,
int  direction,
vtkInformationVector **  inInfoVec,
vtkInformationVector *  outInfoVec
)  [protected, virtual]
 

Reimplemented from vtkExecutive.

Reimplemented in vtkCompositeDataPipeline.

virtual int vtkStreamingDemandDrivenPipeline::VerifyOutputInformation (  int  outputPort,
vtkInformationVector **  inInfoVec,
vtkInformationVector *  outInfoVec
)  [protected, virtual]
 

Reimplemented in vtkCompositeDataPipeline.

virtual int vtkStreamingDemandDrivenPipeline::NeedToExecuteData (  int  outputPort,
vtkInformationVector **  inInfoVec,
vtkInformationVector *  outInfoVec
)  [protected, virtual]
 

Reimplemented from vtkDemandDrivenPipeline.

Reimplemented in vtkCachedStreamingDemandDrivenPipeline.

virtual void vtkStreamingDemandDrivenPipeline::ExecuteDataStart (  vtkInformation *  request,
vtkInformationVector **  inInfoVec,
vtkInformationVector *  outInfoVec
)  [protected, virtual]
 

Reimplemented from vtkDemandDrivenPipeline.

Reimplemented in vtkCompositeDataPipeline.

virtual void vtkStreamingDemandDrivenPipeline::ExecuteDataEnd (  vtkInformation *  request,
vtkInformationVector **  inInfoVec,
vtkInformationVector *  outInfoVec
)  [protected, virtual]
 

Reimplemented from vtkDemandDrivenPipeline.

virtual void vtkStreamingDemandDrivenPipeline::MarkOutputsGenerated (  vtkInformation *  request,
vtkInformationVector **  inInfoVec,
vtkInformationVector *  outInfoVec
)  [protected, virtual]
 

Reimplemented from vtkDemandDrivenPipeline.

virtual void vtkStreamingDemandDrivenPipeline::ResetPipelineInformation (  int  port,
vtkInformation * 
)  [protected, virtual]
 

Reimplemented from vtkDemandDrivenPipeline.

Member Data Documentation

int vtkStreamingDemandDrivenPipeline::ContinueExecuting [protected]
 

Definition at line 223 of file vtkStreamingDemandDrivenPipeline.h.

vtkInformation* vtkStreamingDemandDrivenPipeline::UpdateExtentRequest [protected]
 

Reimplemented in vtkCompositeDataPipeline.

Definition at line 225 of file vtkStreamingDemandDrivenPipeline.h.

int vtkStreamingDemandDrivenPipeline::LastPropogateUpdateExtentShortCircuited [protected]
 

Definition at line 228 of file vtkStreamingDemandDrivenPipeline.h.

The documentation for this class was generated from the following file:
Generated on Tue Jan 22 00:18:44 2008 for VTK by  doxygen 1.4.3-20050530