VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkCompositeDataPipeline Class Reference

Executive supporting composite datasets. More...

#include <vtkCompositeDataPipeline.h>

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

Public Types

typedef vtkStreamingDemandDrivenPipeline Superclass
 
- Public Types inherited from vtkStreamingDemandDrivenPipeline
typedef vtkDemandDrivenPipeline Superclass
 
- Public Types inherited from vtkDemandDrivenPipeline
typedef vtkExecutive Superclass
 
- Public Types inherited from vtkExecutive
enum  { RequestUpstream, RequestDownstream }
 
enum  { BeforeForward, AfterForward }
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkCompositeDataPipelineNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkDataObjectGetCompositeOutputData (int port)
 Returns the data object stored with the DATA_OBJECT() in the output port. More...
 
vtkDataObjectGetCompositeInputData (int port, int index, vtkInformationVector **inInfoVec)
 Returns the data object stored with the DATA_OBJECT() in the input port. More...
 
- Public Member Functions inherited from vtkStreamingDemandDrivenPipeline
vtkStreamingDemandDrivenPipelineNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo) override
 Generalized interface for asking the executive to fulfill update requests. More...
 
vtkTypeBool Update () override
 Bring the outputs up-to-date. More...
 
vtkTypeBool Update (int port) override
 
virtual vtkTypeBool UpdateWholeExtent ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
int PropagateUpdateExtent (int outputPort)
 Propagate the update request from the given output port back through the pipeline. More...
 
int PropagateTime (int outputPort)
 Propagate time through the pipeline. More...
 
int UpdateTimeDependentInformation (int outputPort)
 
int SetRequestExactExtent (int port, int flag)
 This request flag indicates whether the requester can handle more data than requested for the given port. More...
 
int GetRequestExactExtent (int port)
 
- Public Member Functions inherited from vtkDemandDrivenPipeline
vtkDemandDrivenPipelineNewInstance () const
 
int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime) override
 Implement the pipeline modified time request. More...
 
virtual vtkMTimeType GetPipelineMTime ()
 Get the PipelineMTime for this exective. More...
 
virtual int SetReleaseDataFlag (int port, int n)
 Set whether the given output port releases data when it is consumed. More...
 
virtual int GetReleaseDataFlag (int port)
 Get whether the given output port releases data when it is consumed. More...
 
virtual int UpdatePipelineMTime ()
 Bring the PipelineMTime up to date. More...
 
int UpdateDataObject () override
 Bring the output data object's existence up to date. More...
 
int UpdateInformation () override
 Bring the output information up to date. More...
 
virtual int UpdateData (int outputPort)
 Bring the output data up to date. More...
 
- Public Member Functions inherited from vtkExecutive
vtkExecutiveNewInstance () const
 
vtkAlgorithmGetAlgorithm ()
 Get the algorithm to which this executive has been assigned. More...
 
int GetNumberOfInputPorts ()
 Get the number of input/output ports for the algorithm associated with this executive. More...
 
int GetNumberOfOutputPorts ()
 
int GetNumberOfInputConnections (int port)
 Get the number of input connections on the given port. More...
 
virtual vtkInformationGetOutputInformation (int port)
 Get the pipeline information object for the given output port. More...
 
vtkInformationVectorGetOutputInformation ()
 Get the pipeline information object for all output ports. More...
 
vtkInformationGetInputInformation (int port, int connection)
 Get the pipeline information for the given input connection. More...
 
vtkInformationVectorGetInputInformation (int port)
 Get the pipeline information vectors for the given input port. More...
 
vtkInformationVector ** GetInputInformation ()
 Get the pipeline information vectors for all inputs. More...
 
vtkExecutiveGetInputExecutive (int port, int connection)
 Get the executive managing the given input connection. More...
 
virtual vtkDataObjectGetOutputData (int port)
 Get/Set the data object for an output port of the algorithm. More...
 
virtual void SetOutputData (int port, vtkDataObject *, vtkInformation *info)
 
virtual void SetOutputData (int port, vtkDataObject *)
 
virtual vtkDataObjectGetInputData (int port, int connection)
 Get the data object for an input port of the algorithm. More...
 
virtual vtkDataObjectGetInputData (int port, int connection, vtkInformationVector **inInfoVec)
 
void SetSharedInputInformation (vtkInformationVector **inInfoVec)
 Get the output port that produces the given data object. More...
 
void SetSharedOutputInformation (vtkInformationVector *outInfoVec)
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual int CallAlgorithm (vtkInformation *request, int direction, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 An API to CallAlgorithm that allows you to pass in the info objects to be used. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkCompositeDataPipelineNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCompositeDataPipelineSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyLOAD_REQUESTED_BLOCKS ()
 An integer key that indicates to the source to load all requested blocks specified in UPDATE_COMPOSITE_INDICES. More...
 
static vtkInformationObjectBaseKeyCOMPOSITE_DATA_META_DATA ()
 COMPOSITE_DATA_META_DATA is a key placed in the output-port information by readers/sources producing composite datasets. More...
 
static vtkInformationIntegerVectorKeyUPDATE_COMPOSITE_INDICES ()
 UPDATE_COMPOSITE_INDICES is a key placed in the request to request a set of composite indices from a reader/source producing composite dataset. More...
 
static vtkInformationDoubleKeyBLOCK_AMOUNT_OF_DETAIL ()
 BLOCK_AMOUNT_OF_DETAIL is a key placed in the information about a multi-block dataset that indicates how complex the block is. More...
 
- Static Public Member Functions inherited from vtkStreamingDemandDrivenPipeline
static vtkStreamingDemandDrivenPipelineNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkStreamingDemandDrivenPipelineSafeDownCast (vtkObjectBase *o)
 
static int SetWholeExtent (vtkInformation *, int extent[6])
 Set/Get the whole extent of an output port. More...
 
static void GetWholeExtent (vtkInformation *, int extent[6])
 
static int * GetWholeExtent (vtkInformation *)
 
static vtkInformationRequestKeyREQUEST_UPDATE_EXTENT ()
 Key defining a request to propagate the update extent upstream. More...
 
static vtkInformationRequestKeyREQUEST_UPDATE_TIME ()
 Key defining a request to propagate the update extent upstream. More...
 
static vtkInformationRequestKeyREQUEST_TIME_DEPENDENT_INFORMATION ()
 Key defining a request to make sure the meta information is up to date. More...
 
static vtkInformationIntegerKeyCONTINUE_EXECUTING ()
 Key for an algorithm to store in a request to tell this executive to keep executing it. More...
 
static vtkInformationIntegerKeyUPDATE_EXTENT_INITIALIZED ()
 Keys to store an update request in pipeline information. More...
 
static vtkInformationIntegerVectorKeyUPDATE_EXTENT ()
 
static vtkInformationIntegerKeyUPDATE_PIECE_NUMBER ()
 
static vtkInformationIntegerKeyUPDATE_NUMBER_OF_PIECES ()
 
static vtkInformationIntegerKeyUPDATE_NUMBER_OF_GHOST_LEVELS ()
 
static vtkInformationIntegerVectorKeyCOMBINED_UPDATE_EXTENT ()
 Key for combining the update extents requested by all consumers, so that the final extent that is produced satisfies all consumers. More...
 
static vtkInformationIntegerVectorKeyWHOLE_EXTENT ()
 Key to store the whole extent provided in pipeline information. More...
 
static vtkInformationIntegerKeyUNRESTRICTED_UPDATE_EXTENT ()
 This is set if the update extent is not restricted to the whole extent, for sources that can generate an extent of any requested size. More...
 
static vtkInformationIntegerKeyEXACT_EXTENT ()
 Key to specify the request for exact extent in pipeline information. More...
 
static vtkInformationDoubleVectorKeyTIME_STEPS ()
 Key to store available time steps. More...
 
static vtkInformationDoubleVectorKeyTIME_RANGE ()
 Key to store available time range for continuous sources. More...
 
static vtkInformationDoubleKeyUPDATE_TIME_STEP ()
 Update time steps requested by the pipeline. More...
 
static vtkInformationIntegerKeyTIME_DEPENDENT_INFORMATION ()
 Whether there are time dependent meta information if there is, the pipeline will perform two extra passes to gather the time dependent information. More...
 
static vtkInformationDoubleVectorKeyBOUNDS ()
 key to record the bounds of a dataset. More...
 
static void GetUpdateExtent (vtkInformation *, int extent[6])
 Get/Set the update extent for output ports that use 3D extents. More...
 
static int * GetUpdateExtent (vtkInformation *)
 
static int GetUpdatePiece (vtkInformation *)
 Set/Get the update piece, update number of pieces, and update number of ghost levels for an output port. More...
 
static int GetUpdateNumberOfPieces (vtkInformation *)
 
static int GetUpdateGhostLevel (vtkInformation *)
 
- Static Public Member Functions inherited from vtkDemandDrivenPipeline
static vtkDemandDrivenPipelineNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDemandDrivenPipelineSafeDownCast (vtkObjectBase *o)
 
static vtkInformationRequestKeyREQUEST_DATA_OBJECT ()
 Key defining a request to make sure the output data objects exist. More...
 
static vtkInformationRequestKeyREQUEST_INFORMATION ()
 Key defining a request to make sure the output information is up to date. More...
 
static vtkInformationRequestKeyREQUEST_DATA ()
 Key defining a request to make sure the output data are up to date. More...
 
static vtkInformationRequestKeyREQUEST_DATA_NOT_GENERATED ()
 Key defining a request to mark outputs that will NOT be generated during a REQUEST_DATA. More...
 
static vtkInformationIntegerKeyRELEASE_DATA ()
 Key to specify in pipeline information the request that data be released after it is used. More...
 
static vtkInformationIntegerKeyDATA_NOT_GENERATED ()
 Key to store a mark for an output that will not be generated. More...
 
static vtkDataObjectNewDataObject (const char *type)
 Create (New) and return a data object of the given type. More...
 
- Static Public Member Functions inherited from vtkExecutive
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkExecutiveSafeDownCast (vtkObjectBase *o)
 
static vtkInformationExecutivePortKeyPRODUCER ()
 Information key to store the executive/port number producing an information object. More...
 
static vtkInformationExecutivePortVectorKeyCONSUMERS ()
 Information key to store the executive/port number pairs consuming an information object. More...
 
static vtkInformationIntegerKeyFROM_OUTPUT_PORT ()
 Information key to store the output port number from which a request is made. More...
 
static vtkInformationIntegerKeyALGORITHM_BEFORE_FORWARD ()
 Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests. More...
 
static vtkInformationIntegerKeyALGORITHM_AFTER_FORWARD ()
 
static vtkInformationIntegerKeyALGORITHM_DIRECTION ()
 
static vtkInformationIntegerKeyFORWARD_DIRECTION ()
 
static vtkInformationKeyVectorKeyKEYS_TO_COPY ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCompositeDataPipeline ()
 
 ~vtkCompositeDataPipeline () override
 
int ForwardUpstream (vtkInformation *request) override
 
virtual int ForwardUpstream (int i, int j, vtkInformation *request)
 
void CopyDefaultInformation (vtkInformation *request, int direction, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
 
virtual void PushInformation (vtkInformation *)
 
virtual void PopInformation (vtkInformation *)
 
int ExecuteDataObject (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo) override
 
int ExecuteData (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
 
void ExecuteDataStart (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
 
int NeedToExecuteData (int outputPort, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
 
virtual int CheckCompositeData (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
 
virtual void ExecuteSimpleAlgorithm (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int compositePort)
 
virtual void ExecuteEach (vtkCompositeDataIterator *iter, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int compositePort, int connection, vtkInformation *request, std::vector< vtkSmartPointer< vtkCompositeDataSet > > &compositeOutput)
 
std::vector< vtkDataObject * > ExecuteSimpleAlgorithmForBlock (vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, vtkInformation *inInfo, vtkInformation *request, vtkDataObject *dobj)
 
bool ShouldIterateOverInput (vtkInformationVector **inInfoVec, int &compositePort)
 
int InputTypeIsValid (int port, int index, vtkInformationVector **inInfoVec) override
 
void ResetPipelineInformation (int port, vtkInformation *) override
 
std::vector< vtkSmartPointer< vtkDataObject > > CreateOutputCompositeDataSet (vtkCompositeDataSet *input, int compositePort, int numOutputPorts)
 Tries to create the best possible composite data output for the given input and non-composite algorithm output. More...
 
void MarkOutputsGenerated (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
 
int NeedToExecuteBasedOnCompositeIndices (vtkInformation *outInfo)
 
- Protected Member Functions inherited from vtkStreamingDemandDrivenPipeline
 vtkStreamingDemandDrivenPipeline ()
 
 ~vtkStreamingDemandDrivenPipeline () override
 
virtual int NeedToExecuteBasedOnTime (vtkInformation *outInfo, vtkDataObject *dataObject)
 
int ExecuteInformation (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
 
void CopyDefaultInformation (vtkInformation *request, int direction, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
 
virtual int VerifyOutputInformation (int outputPort, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec)
 
int NeedToExecuteData (int outputPort, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
 
void ExecuteDataStart (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
 
void ExecuteDataEnd (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
 
void MarkOutputsGenerated (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec) override
 
void ResetPipelineInformation (int port, vtkInformation *) override
 
- Protected Member Functions inherited from vtkDemandDrivenPipeline
 vtkDemandDrivenPipeline ()
 
 ~vtkDemandDrivenPipeline () override
 
virtual int CheckDataObject (int port, vtkInformationVector *outInfo)
 
int InputCountIsValid (vtkInformationVector **)
 
int InputCountIsValid (int port, vtkInformationVector **)
 
int InputTypeIsValid (vtkInformationVector **)
 
int InputTypeIsValid (int port, vtkInformationVector **)
 
int InputFieldsAreValid (vtkInformationVector **)
 
int InputFieldsAreValid (int port, vtkInformationVector **)
 
virtual int InputFieldsAreValid (int port, int index, vtkInformationVector **)
 
int DataSetAttributeExists (vtkDataSetAttributes *dsa, vtkInformation *field)
 
int FieldArrayExists (vtkFieldData *data, vtkInformation *field)
 
int ArrayIsValid (vtkAbstractArray *array, vtkInformation *field)
 
int InputIsOptional (int port)
 
int InputIsRepeatable (int port)
 
- Protected Member Functions inherited from vtkExecutive
 vtkExecutive ()
 
 ~vtkExecutive () override
 
int InputPortIndexInRange (int port, const char *action)
 
int OutputPortIndexInRange (int port, const char *action)
 
int CheckAlgorithm (const char *method, vtkInformation *request)
 
virtual int ForwardDownstream (vtkInformation *request)
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetAlgorithm (vtkAlgorithm *algorithm)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static vtkInformationIntegerKeySUPPRESS_RESET_PI ()
 
static vtkInformationIntegerVectorKeyDATA_COMPOSITE_INDICES ()
 COMPOSITE_INDICES() is put in the output information by the executive if the request has UPDATE_COMPOSITE_INDICES() using the generated composite dataset's structure. More...
 
- Static Protected Member Functions inherited from vtkStreamingDemandDrivenPipeline
static vtkInformationDoubleKeyPREVIOUS_UPDATE_TIME_STEP ()
 Keep track of the update time request corresponding to the previous executing. More...
 

Protected Attributes

int InLocalLoop
 
vtkInformationInformationCache
 
vtkInformationGenericRequest
 
vtkInformationInformationRequest
 
- Protected Attributes inherited from vtkStreamingDemandDrivenPipeline
int ContinueExecuting
 
vtkInformationUpdateExtentRequest
 
vtkInformationUpdateTimeRequest
 
vtkInformationTimeDependentInformationRequest
 
vtkInformationIteratorInformationIterator
 
int LastPropogateUpdateExtentShortCircuited
 
- Protected Attributes inherited from vtkDemandDrivenPipeline
vtkMTimeType PipelineMTime
 
vtkTimeStamp DataObjectTime
 
vtkTimeStamp InformationTime
 
vtkTimeStamp DataTime
 
vtkInformationInfoRequest
 
vtkInformationDataObjectRequest
 
vtkInformationDataRequest
 
- Protected Attributes inherited from vtkExecutive
vtkAlgorithmAlgorithm
 
int InAlgorithm
 
vtkInformationVector ** SharedInputInformation
 
vtkInformationVectorSharedOutputInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Executive supporting composite datasets.

vtkCompositeDataPipeline is an executive that supports the processing of composite dataset. It supports algorithms that are aware of composite dataset as well as those that are not. Type checking is performed at run time. Algorithms that are not composite dataset-aware have to support all dataset types contained in the composite dataset. The pipeline execution can be summarized as follows:

Definition at line 62 of file vtkCompositeDataPipeline.h.

Member Typedef Documentation

◆ Superclass

Definition at line 67 of file vtkCompositeDataPipeline.h.

Constructor & Destructor Documentation

◆ vtkCompositeDataPipeline()

vtkCompositeDataPipeline::vtkCompositeDataPipeline ( )
protected

◆ ~vtkCompositeDataPipeline()

vtkCompositeDataPipeline::~vtkCompositeDataPipeline ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkCompositeDataPipeline* vtkCompositeDataPipeline::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkCompositeDataPipeline::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkCompositeDataPipeline::IsA ( const char *  name)
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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkStreamingDemandDrivenPipeline.

Reimplemented in vtkThreadedCompositeDataPipeline.

◆ SafeDownCast()

static vtkCompositeDataPipeline* vtkCompositeDataPipeline::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCompositeDataPipeline::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkCompositeDataPipeline* vtkCompositeDataPipeline::NewInstance ( ) const

◆ PrintSelf()

void vtkCompositeDataPipeline::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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 vtkObject.

Reimplemented in vtkThreadedCompositeDataPipeline.

◆ GetCompositeOutputData()

vtkDataObject* vtkCompositeDataPipeline::GetCompositeOutputData ( int  port)

Returns the data object stored with the DATA_OBJECT() in the output port.

◆ GetCompositeInputData()

vtkDataObject* vtkCompositeDataPipeline::GetCompositeInputData ( int  port,
int  index,
vtkInformationVector **  inInfoVec 
)

Returns the data object stored with the DATA_OBJECT() in the input port.

◆ LOAD_REQUESTED_BLOCKS()

static vtkInformationIntegerKey* vtkCompositeDataPipeline::LOAD_REQUESTED_BLOCKS ( )
static

An integer key that indicates to the source to load all requested blocks specified in UPDATE_COMPOSITE_INDICES.

◆ COMPOSITE_DATA_META_DATA()

static vtkInformationObjectBaseKey* vtkCompositeDataPipeline::COMPOSITE_DATA_META_DATA ( )
static

COMPOSITE_DATA_META_DATA is a key placed in the output-port information by readers/sources producing composite datasets.

This meta-data provides information about the structure of the composite dataset and things like data-bounds etc. *** THIS IS AN EXPERIMENTAL FEATURE. IT MAY CHANGE WITHOUT NOTICE ***

◆ UPDATE_COMPOSITE_INDICES()

static vtkInformationIntegerVectorKey* vtkCompositeDataPipeline::UPDATE_COMPOSITE_INDICES ( )
static

UPDATE_COMPOSITE_INDICES is a key placed in the request to request a set of composite indices from a reader/source producing composite dataset.

Typically, the reader publishes its structure using COMPOSITE_DATA_META_DATA() and then the sink requests blocks of interest using UPDATE_COMPOSITE_INDICES(). Note that UPDATE_COMPOSITE_INDICES has to be sorted vector with increasing indices. *** THIS IS AN EXPERIMENTAL FEATURE. IT MAY CHANGE WITHOUT NOTICE ***

◆ BLOCK_AMOUNT_OF_DETAIL()

static vtkInformationDoubleKey* vtkCompositeDataPipeline::BLOCK_AMOUNT_OF_DETAIL ( )
static

BLOCK_AMOUNT_OF_DETAIL is a key placed in the information about a multi-block dataset that indicates how complex the block is.

It is intended to work with multi-resolution streaming code. For example in a multi-resolution dataset of points, this key might store the number of points. *** THIS IS AN EXPERIMENTAL FEATURE. IT MAY CHANGE WITHOUT NOTICE ***

◆ ForwardUpstream() [1/2]

int vtkCompositeDataPipeline::ForwardUpstream ( vtkInformation request)
overrideprotectedvirtual

Reimplemented from vtkExecutive.

◆ ForwardUpstream() [2/2]

virtual int vtkCompositeDataPipeline::ForwardUpstream ( int  i,
int  j,
vtkInformation request 
)
protectedvirtual

◆ CopyDefaultInformation()

void vtkCompositeDataPipeline::CopyDefaultInformation ( vtkInformation request,
int  direction,
vtkInformationVector **  inInfoVec,
vtkInformationVector outInfoVec 
)
overrideprotectedvirtual

Reimplemented from vtkExecutive.

◆ PushInformation()

virtual void vtkCompositeDataPipeline::PushInformation ( vtkInformation )
protectedvirtual

◆ PopInformation()

virtual void vtkCompositeDataPipeline::PopInformation ( vtkInformation )
protectedvirtual

◆ ExecuteDataObject()

int vtkCompositeDataPipeline::ExecuteDataObject ( vtkInformation request,
vtkInformationVector **  inInfo,
vtkInformationVector outInfo 
)
overrideprotectedvirtual

Reimplemented from vtkDemandDrivenPipeline.

◆ ExecuteData()

int vtkCompositeDataPipeline::ExecuteData ( vtkInformation request,
vtkInformationVector **  inInfoVec,
vtkInformationVector outInfoVec 
)
overrideprotectedvirtual

Reimplemented from vtkDemandDrivenPipeline.

◆ ExecuteDataStart()

void vtkCompositeDataPipeline::ExecuteDataStart ( vtkInformation request,
vtkInformationVector **  inInfoVec,
vtkInformationVector outInfoVec 
)
overrideprotectedvirtual

Reimplemented from vtkDemandDrivenPipeline.

◆ NeedToExecuteData()

int vtkCompositeDataPipeline::NeedToExecuteData ( int  outputPort,
vtkInformationVector **  inInfoVec,
vtkInformationVector outInfoVec 
)
overrideprotectedvirtual

Reimplemented from vtkDemandDrivenPipeline.

◆ CheckCompositeData()

virtual int vtkCompositeDataPipeline::CheckCompositeData ( vtkInformation request,
vtkInformationVector **  inInfoVec,
vtkInformationVector outInfoVec 
)
protectedvirtual

◆ ExecuteSimpleAlgorithm()

virtual void vtkCompositeDataPipeline::ExecuteSimpleAlgorithm ( vtkInformation request,
vtkInformationVector **  inInfoVec,
vtkInformationVector outInfoVec,
int  compositePort 
)
protectedvirtual

◆ ExecuteEach()

virtual void vtkCompositeDataPipeline::ExecuteEach ( vtkCompositeDataIterator iter,
vtkInformationVector **  inInfoVec,
vtkInformationVector outInfoVec,
int  compositePort,
int  connection,
vtkInformation request,
std::vector< vtkSmartPointer< vtkCompositeDataSet > > &  compositeOutput 
)
protectedvirtual

◆ ExecuteSimpleAlgorithmForBlock()

std::vector<vtkDataObject*> vtkCompositeDataPipeline::ExecuteSimpleAlgorithmForBlock ( vtkInformationVector **  inInfoVec,
vtkInformationVector outInfoVec,
vtkInformation inInfo,
vtkInformation request,
vtkDataObject dobj 
)
protected

◆ ShouldIterateOverInput()

bool vtkCompositeDataPipeline::ShouldIterateOverInput ( vtkInformationVector **  inInfoVec,
int &  compositePort 
)
protected

◆ InputTypeIsValid()

int vtkCompositeDataPipeline::InputTypeIsValid ( int  port,
int  index,
vtkInformationVector **  inInfoVec 
)
overrideprotectedvirtual

Reimplemented from vtkDemandDrivenPipeline.

◆ ResetPipelineInformation()

void vtkCompositeDataPipeline::ResetPipelineInformation ( int  port,
vtkInformation  
)
overrideprotectedvirtual

Implements vtkExecutive.

◆ CreateOutputCompositeDataSet()

std::vector<vtkSmartPointer<vtkDataObject> > vtkCompositeDataPipeline::CreateOutputCompositeDataSet ( vtkCompositeDataSet input,
int  compositePort,
int  numOutputPorts 
)
protected

Tries to create the best possible composite data output for the given input and non-composite algorithm output.

Returns a new instance on success. It's main purpose is to determine if vtkHierarchicalBoxDataSet can be propagated as vtkHierarchicalBoxDataSet in the output (if the algorithm can produce vtkUniformGrid given vtkUniformGrid inputs) or if it should be downgraded to a vtkMultiBlockDataSet.

◆ MarkOutputsGenerated()

void vtkCompositeDataPipeline::MarkOutputsGenerated ( vtkInformation request,
vtkInformationVector **  inInfoVec,
vtkInformationVector outInfoVec 
)
overrideprotectedvirtual

Reimplemented from vtkDemandDrivenPipeline.

◆ NeedToExecuteBasedOnCompositeIndices()

int vtkCompositeDataPipeline::NeedToExecuteBasedOnCompositeIndices ( vtkInformation outInfo)
protected

◆ SUPPRESS_RESET_PI()

static vtkInformationIntegerKey* vtkCompositeDataPipeline::SUPPRESS_RESET_PI ( )
staticprotected

◆ DATA_COMPOSITE_INDICES()

static vtkInformationIntegerVectorKey* vtkCompositeDataPipeline::DATA_COMPOSITE_INDICES ( )
staticprotected

COMPOSITE_INDICES() is put in the output information by the executive if the request has UPDATE_COMPOSITE_INDICES() using the generated composite dataset's structure.

Note that COMPOSITE_INDICES has to be sorted vector with increasing indices. *** THIS IS AN EXPERIMENTAL FEATURE. IT MAY CHANGE WITHOUT NOTICE ***

Member Data Documentation

◆ InLocalLoop

int vtkCompositeDataPipeline::InLocalLoop
protected

Definition at line 153 of file vtkCompositeDataPipeline.h.

◆ InformationCache

vtkInformation* vtkCompositeDataPipeline::InformationCache
protected

Definition at line 170 of file vtkCompositeDataPipeline.h.

◆ GenericRequest

vtkInformation* vtkCompositeDataPipeline::GenericRequest
protected

Definition at line 172 of file vtkCompositeDataPipeline.h.

◆ InformationRequest

vtkInformation* vtkCompositeDataPipeline::InformationRequest
protected

Definition at line 173 of file vtkCompositeDataPipeline.h.


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