Executive supporting partial updates. More...

#include <vtkStreamingDemandDrivenPipeline.h>

Inheritance diagram for vtkStreamingDemandDrivenPipeline:

Collaboration diagram for vtkStreamingDemandDrivenPipeline:

Public Types
enum	NO_PRIOR_TEMPORAL_ACCESS_STATES { NO_PRIOR_TEMPORAL_ACCESS_CONTINUE = 1 , NO_PRIOR_TEMPORAL_ACCESS_RESET = 2 }
	States that the information key `NO_PRIOR_TEMPORAL_ACCESS` can have. More...

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.

vtkStreamingDemandDrivenPipeline *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo) override
	Generalized interface for asking the executive to fulfill update requests.

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

int	PropagateUpdateExtent (int outputPort)
	Propagate the update request from the given output port back through the pipeline.


vtkTypeBool	Update () override
	Bring the outputs up-to-date.

vtkTypeBool	Update (int port) override
	Bring the outputs up-to-date.

virtual vtkTypeBool	UpdateWholeExtent ()
	Bring the outputs up-to-date.


int	PropagateTime (int outputPort)
	Propagate time through the pipeline.

int	UpdateTimeDependentInformation (int outputPort)
	Propagate time through the pipeline.


int	SetRequestExactExtent (int port, int flag)
	This request flag indicates whether the requester can handle more data than requested for the given port.

int	GetRequestExactExtent (int port)
	This request flag indicates whether the requester can handle more data than requested for the given port.

Public Member Functions inherited from vtkDemandDrivenPipeline
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkDemandDrivenPipeline *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo) override
	Generalized interface for asking the executive to fulfill update requests.

int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime) override
	Implement the pipeline modified time request.

virtual int	SetReleaseDataFlag (int port, vtkTypeBool n)
	Set whether the given output port releases data when it is consumed.

virtual vtkTypeBool	GetReleaseDataFlag (int port)
	Get whether the given output port releases data when it is consumed.

virtual int	UpdatePipelineMTime ()
	Bring the PipelineMTime up to date.

int	UpdateDataObject () override
	Bring the output data object's existence up to date.

int	UpdateInformation () override
	Bring the output information up to date.

virtual int	UpdateData (int outputPort)
	Bring the output data up to date.

virtual vtkMTimeType	GetPipelineMTime ()
	Get the PipelineMTime for this exective.

Public Member Functions inherited from vtkExecutive
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkExecutive *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkAlgorithm *	GetAlgorithm ()
	Get the algorithm to which this executive has been assigned.

virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Generalized interface for asking the executive to fulfill pipeline requests.

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.

virtual int	UpdateInformation ()
	Bring the output information up to date.

int	GetNumberOfInputConnections (int port)
	Get the number of input connections on the given port.

virtual vtkInformation *	GetOutputInformation (int port)
	Get the pipeline information object for the given output port.

vtkInformationVector *	GetOutputInformation ()
	Get the pipeline information object for all output ports.

vtkInformation *	GetInputInformation (int port, int connection)
	Get the pipeline information for the given input connection.

vtkInformationVector *	GetInputInformation (int port)
	Get the pipeline information vectors for the given input port.

vtkInformationVector **	GetInputInformation ()
	Get the pipeline information vectors for all inputs.

vtkExecutive *	GetInputExecutive (int port, int connection)
	Get the executive managing the given input connection.

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.

int	GetNumberOfInputPorts ()
	Get the number of input/output ports for the algorithm associated with this executive.

int	GetNumberOfOutputPorts ()
	Get the number of input/output ports for the algorithm associated with this executive.

virtual vtkDataObject *	GetOutputData (int port)
	Get/Set the data object for an output port of the algorithm.

virtual void	SetOutputData (int port, vtkDataObject , vtkInformation info)
	Get/Set the data object for an output port of the algorithm.

virtual void	SetOutputData (int port, vtkDataObject *)
	Get/Set the data object for an output port of the algorithm.

virtual vtkDataObject *	GetInputData (int port, int connection)
	Get the data object for an input port of the algorithm.

virtual vtkDataObject *	GetInputData (int port, int connection, vtkInformationVector **inInfoVec)
	Get the data object for an input port of the algorithm.

void	SetSharedInputInformation (vtkInformationVector **inInfoVec)
	Get the output port that produces the given data object.

void	SetSharedOutputInformation (vtkInformationVector *outInfoVec)
	Get the output port that produces the given data object.

bool	UsesGarbageCollector () const override
	Participate in garbage collection.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkStreamingDemandDrivenPipeline *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkStreamingDemandDrivenPipeline *	SafeDownCast (vtkObjectBase *o)

static vtkInformationRequestKey *	REQUEST_UPDATE_EXTENT ()
	Key defining a request to propagate the update extent upstream.

static vtkInformationRequestKey *	REQUEST_UPDATE_TIME ()
	Key defining a request to propagate the update extent upstream.

static vtkInformationRequestKey *	REQUEST_TIME_DEPENDENT_INFORMATION ()
	Key defining a request to make sure the meta information is up to date.

static vtkInformationIntegerKey *	CONTINUE_EXECUTING ()
	Key for an algorithm to store in a request to tell this executive to keep executing it.

static vtkInformationIntegerKey *	UPDATE_EXTENT_INITIALIZED ()
	Keys to store an update request in pipeline information.

static vtkInformationIntegerVectorKey *	UPDATE_EXTENT ()

static vtkInformationIntegerKey *	UPDATE_PIECE_NUMBER ()

static vtkInformationIntegerKey *	UPDATE_NUMBER_OF_PIECES ()

static vtkInformationIntegerKey *	UPDATE_NUMBER_OF_GHOST_LEVELS ()

static vtkInformationIntegerVectorKey *	COMBINED_UPDATE_EXTENT ()
	Key for combining the update extents requested by all consumers, so that the final extent that is produced satisfies all consumers.

static vtkInformationIntegerVectorKey *	WHOLE_EXTENT ()
	Key to store the whole extent provided in pipeline information.

static vtkInformationIntegerKey *	UNRESTRICTED_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.

static vtkInformationIntegerKey *	EXACT_EXTENT ()
	Key to specify the request for exact extent in pipeline information.

static vtkInformationDoubleVectorKey *	TIME_STEPS ()
	Key to store available time steps.

static vtkInformationDoubleVectorKey *	TIME_RANGE ()
	Key to store available time range for continuous sources.

static vtkInformationDoubleKey *	UPDATE_TIME_STEP ()
	Update time steps requested by the pipeline.

static vtkInformationIntegerKey *	TIME_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.

static vtkInformationDoubleVectorKey *	BOUNDS ()
	key to record the bounds of a dataset.

static vtkInformationIntegerKey *	NO_PRIOR_TEMPORAL_ACCESS ()
	Key to tell whether the data has all its time steps generated.


static int	SetWholeExtent (vtkInformation *, int extent[6])
	Set/Get the whole extent of an output port.

static void	GetWholeExtent (vtkInformation *, int extent[6])
	Set/Get the whole extent of an output port.

static int *	GetWholeExtent (vtkInformation *)
	Set/Get the whole extent of an output port.


static void	GetUpdateExtent (vtkInformation *, int extent[6])
	Get/Set the update extent for output ports that use 3D extents.

static int *	GetUpdateExtent (vtkInformation *)
	Get/Set the update extent for output ports that use 3D extents.


static int	GetUpdatePiece (vtkInformation *)
	Set/Get the update piece, update number of pieces, and update number of ghost levels for an output port.

static int	GetUpdateNumberOfPieces (vtkInformation *)
	Set/Get the update piece, update number of pieces, and update number of ghost levels for an output port.

static int	GetUpdateGhostLevel (vtkInformation *)
	Set/Get the update piece, update number of pieces, and update number of ghost levels for an output port.

Static Public Member Functions inherited from vtkDemandDrivenPipeline
static vtkDemandDrivenPipeline *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDemandDrivenPipeline *	SafeDownCast (vtkObjectBase *o)

static vtkInformationRequestKey *	REQUEST_DATA_OBJECT ()
	Key defining a request to make sure the output data objects exist.

static vtkInformationRequestKey *	REQUEST_INFORMATION ()
	Key defining a request to make sure the output information is up to date.

static vtkInformationRequestKey *	REQUEST_DATA ()
	Key defining a request to make sure the output data are up to date.

static vtkInformationRequestKey *	REQUEST_DATA_NOT_GENERATED ()
	Key defining a request to mark outputs that will NOT be generated during a REQUEST_DATA.

static vtkInformationIntegerKey *	RELEASE_DATA ()
	Key to specify in pipeline information the request that data be released after it is used.

static vtkInformationIntegerKey *	DATA_NOT_GENERATED ()
	Key to store a mark for an output that will not be generated.

static vtkDataObject *	NewDataObject (const char *type)
	Create (New) and return a data object of the given type.

Static Public Member Functions inherited from vtkExecutive
static vtkTypeBool	IsTypeOf (const char *type)

static vtkExecutive *	SafeDownCast (vtkObjectBase *o)

static vtkInformationExecutivePortKey *	PRODUCER ()
	Information key to store the executive/port number producing an information object.

static vtkInformationExecutivePortVectorKey *	CONSUMERS ()
	Information key to store the executive/port number pairs consuming an information object.

static vtkInformationIntegerKey *	FROM_OUTPUT_PORT ()
	Information key to store the output port number from which a request is made.

static vtkInformationIntegerKey *	ALGORITHM_BEFORE_FORWARD ()
	Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.

static vtkInformationIntegerKey *	ALGORITHM_AFTER_FORWARD ()
	Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.

static vtkInformationIntegerKey *	ALGORITHM_DIRECTION ()
	Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.

static vtkInformationIntegerKey *	FORWARD_DIRECTION ()
	Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.

static vtkInformationKeyVectorKey *	KEYS_TO_COPY ()
	Keys to program vtkExecutive::ProcessRequest with the default behavior for unknown requests.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	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
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDemandDrivenPipeline ()

	~vtkDemandDrivenPipeline () override

virtual int	ExecuteDataObject (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)

virtual int	ExecuteInformation (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)

virtual int	ExecuteData (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)

void	ResetPipelineInformation (int, vtkInformation *) override

virtual int	CheckDataObject (int port, vtkInformationVector *outInfo)

int	InputCountIsValid (vtkInformationVector **)

int	InputCountIsValid (int port, vtkInformationVector **)

int	InputTypeIsValid (vtkInformationVector **)

int	InputTypeIsValid (int port, vtkInformationVector **)

virtual int	InputTypeIsValid (int port, int index, 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)

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)

Protected Member Functions inherited from vtkExecutive
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkExecutive ()

	~vtkExecutive () override

int	InputPortIndexInRange (int port, const char *action)

int	OutputPortIndexInRange (int port, const char *action)

int	CheckAlgorithm (const char method, vtkInformation request)

bool	CheckAbortedInput (vtkInformationVector **inInfoVec)
	Checks to see if an inputs have ABORTED set.

virtual int	ForwardDownstream (vtkInformation *request)

virtual int	ForwardUpstream (vtkInformation *request)

virtual void	CopyDefaultInformation (vtkInformation request, int direction, vtkInformationVector inInfo, vtkInformationVector outInfo)

virtual void	ResetPipelineInformation (int port, vtkInformation *)=0

virtual int	UpdateDataObject ()=0

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static vtkInformationDoubleKey *	PREVIOUS_UPDATE_TIME_STEP ()
	Keep track of the update time request corresponding to the previous executing.

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
int	ContinueExecuting

vtkInformation *	UpdateExtentRequest

vtkInformation *	UpdateTimeRequest

vtkInformation *	TimeDependentInformationRequest

vtkInformationIterator *	InformationIterator

int	LastPropogateUpdateExtentShortCircuited

Protected Attributes inherited from vtkDemandDrivenPipeline
vtkMTimeType	PipelineMTime

vtkTimeStamp	DataObjectTime

vtkTimeStamp	InformationTime

vtkTimeStamp	DataTime

vtkInformation *	InfoRequest

vtkInformation *	DataObjectRequest

vtkInformation *	DataRequest

Protected Attributes inherited from vtkExecutive
vtkAlgorithm *	Algorithm

int	InAlgorithm

vtkInformationVector **	SharedInputInformation

vtkInformationVector *	SharedOutputInformation

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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)

Online Examples:

vtkImageAlgorithmFilter

vtkTestAlgorithmFilter

vtkTestAlgorithmSource

vtkTestFilterProgressFilter

vtkTestFilterSelfProgressFilter

vtkTestGraphAlgorithmFilter

vtkTestGraphAlgorithmSource

vtkTestMultipleInputPortsFilter

vtkTestReader

ImageClip

Tests:: vtkStreamingDemandDrivenPipeline (Tests)

Definition at line 151 of file vtkStreamingDemandDrivenPipeline.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDemandDrivenPipeline vtkStreamingDemandDrivenPipeline::Superclass

Definition at line 156 of file vtkStreamingDemandDrivenPipeline.h.

Member Enumeration Documentation

◆ NO_PRIOR_TEMPORAL_ACCESS_STATES

enum vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS_STATES

States that the information key NO_PRIOR_TEMPORAL_ACCESS can have.

Enumerator

NO_PRIOR_TEMPORAL_ACCESS_CONTINUE

Notifies that the current UPDATE_TIME_STEP() is to be integrated in the output of the current vtkAlgorithm.

NO_PRIOR_TEMPORAL_ACCESS_RESET

Notifies that the filter should reset its internal state.

This bit should be activated if one wants to rerun the time steps from scratch. It does not need to be set on the first update of the pipeline.

Definition at line 361 of file vtkStreamingDemandDrivenPipeline.h.

Constructor & Destructor Documentation

◆ vtkStreamingDemandDrivenPipeline()

vtkStreamingDemandDrivenPipeline::vtkStreamingDemandDrivenPipeline ( )

protected

◆ ~vtkStreamingDemandDrivenPipeline()

vtkStreamingDemandDrivenPipeline::~vtkStreamingDemandDrivenPipeline ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkStreamingDemandDrivenPipeline * vtkStreamingDemandDrivenPipeline::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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

Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkCompositeDataPipeline, vtkThreadedCompositeDataPipeline, and vtkImageImportExecutive.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkStreamingDemandDrivenPipeline::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDemandDrivenPipeline.

Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkCompositeDataPipeline, vtkThreadedCompositeDataPipeline, and vtkImageImportExecutive.

◆ NewInstance()

vtkStreamingDemandDrivenPipeline * vtkStreamingDemandDrivenPipeline::NewInstance ( ) const

◆ PrintSelf()

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

Reimplemented in vtkThreadedCompositeDataPipeline.

◆ ProcessRequest()

vtkTypeBool vtkStreamingDemandDrivenPipeline::ProcessRequest	(	vtkInformation *	request,
		vtkInformationVector **	inInfo,
		vtkInformationVector *	outInfo
	)

overridevirtual

Generalized interface for asking the executive to fulfill update requests.

Reimplemented from vtkDemandDrivenPipeline.

◆ Update() [1/3]

vtkTypeBool vtkStreamingDemandDrivenPipeline::Update ( )

overridevirtual

Bring the outputs up-to-date.

Reimplemented from vtkDemandDrivenPipeline.

◆ Update() [2/3]

vtkTypeBool vtkStreamingDemandDrivenPipeline::Update ( int port )

overridevirtual

Bring the outputs up-to-date.

Reimplemented from vtkDemandDrivenPipeline.

◆ UpdateWholeExtent()

virtual vtkTypeBool vtkStreamingDemandDrivenPipeline::UpdateWholeExtent ( )

virtual

Bring the outputs up-to-date.

◆ Update() [3/3]

virtual vtkTypeBool vtkStreamingDemandDrivenPipeline::Update	(	int	port,
		vtkInformationVector *	requests
	)

virtual

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

The requests argument should contain an information object for each port that requests need to be passed. For each of those, the pipeline will copy all keys to the output information before execution. This is equivalent to:

* executive->UpdateInformation();
* for (int i=0; i<executive->GetNumberOfOutputPorts(); i++)
* {
* vtkInformation* portRequests = requests->GetInformationObject(i);
* if (portRequests)
* {
* executive->GetOutputInformation(i)->Append(portRequests);
* }
* }
* executive->Update();
*

Available requests include UPDATE_PIECE_NUMBER(), UPDATE_NUMBER_OF_PIECES() UPDATE_EXTENT() etc etc.

◆ PropagateUpdateExtent()

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.

◆ PropagateTime()

int vtkStreamingDemandDrivenPipeline::PropagateTime ( int outputPort )

Propagate time through the pipeline.

this is a special pass only necessary if there is temporal meta data that must be updated

◆ UpdateTimeDependentInformation()

int vtkStreamingDemandDrivenPipeline::UpdateTimeDependentInformation ( int outputPort )

Propagate time through the pipeline.

this is a special pass only necessary if there is temporal meta data that must be updated

◆ SetWholeExtent()

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

static

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.

◆ GetWholeExtent() [1/2]

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

static

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.

◆ GetWholeExtent() [2/2]

static int * vtkStreamingDemandDrivenPipeline::GetWholeExtent ( vtkInformation * )

static

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.

◆ SetRequestExactExtent()

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 consumer cannot handle this (i.e. DataSetToDataSetfilter) the image will crop itself. This functionality used to be in ImageToStructuredPoints.

◆ GetRequestExactExtent()

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 consumer cannot handle this (i.e. DataSetToDataSetfilter) the image will crop itself. This functionality used to be in ImageToStructuredPoints.

◆ NO_PRIOR_TEMPORAL_ACCESS()

static vtkInformationIntegerKey * vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS ( )

static

Key to tell whether the data has all its time steps generated.

It is typically used for in situ, where you want to be able to visualize a simulation while it is running. It effectively tells the downstream algorithms integrating over all the timesteps that the current set of available timesteps is not necessarily complete. As a result, they will produce a valid output for each requested timestep and keep some cache helping them to retrieve upcoming timesteps as they arrive.

Note: One should check the actual value of this key. Possible values are listed in NO_PRIOR_TEMPORAL_ACCESS_STATES.

◆ GetUpdateExtent() [1/2]

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

static

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

◆ GetUpdateExtent() [2/2]

static int * vtkStreamingDemandDrivenPipeline::GetUpdateExtent ( vtkInformation * )

static

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

◆ GetUpdatePiece()

static int vtkStreamingDemandDrivenPipeline::GetUpdatePiece ( vtkInformation * )

static

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.

◆ GetUpdateNumberOfPieces()

static int vtkStreamingDemandDrivenPipeline::GetUpdateNumberOfPieces ( vtkInformation * )

static

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.

◆ GetUpdateGhostLevel()

static int vtkStreamingDemandDrivenPipeline::GetUpdateGhostLevel ( vtkInformation * )

static

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.

◆ NeedToExecuteBasedOnTime()

virtual int vtkStreamingDemandDrivenPipeline::NeedToExecuteBasedOnTime	(	vtkInformation *	outInfo,
		vtkDataObject *	dataObject
	)

protectedvirtual

◆ ExecuteInformation()

int vtkStreamingDemandDrivenPipeline::ExecuteInformation	(	vtkInformation *	request,
		vtkInformationVector **	inInfoVec,
		vtkInformationVector *	outInfoVec
	)

overrideprotectedvirtual

Reimplemented from vtkDemandDrivenPipeline.

◆ CopyDefaultInformation()

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

overrideprotectedvirtual

Reimplemented from vtkExecutive.

◆ VerifyOutputInformation()

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

protectedvirtual

◆ NeedToExecuteData()

int vtkStreamingDemandDrivenPipeline::NeedToExecuteData	(	int	outputPort,
		vtkInformationVector **	inInfoVec,
		vtkInformationVector *	outInfoVec
	)

overrideprotectedvirtual

Reimplemented from vtkDemandDrivenPipeline.

◆ ExecuteDataStart()

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

overrideprotectedvirtual

Reimplemented from vtkDemandDrivenPipeline.

◆ ExecuteDataEnd()

void vtkStreamingDemandDrivenPipeline::ExecuteDataEnd	(	vtkInformation *	request,
		vtkInformationVector **	inInfoVec,
		vtkInformationVector *	outInfoVec
	)

overrideprotectedvirtual

Reimplemented from vtkDemandDrivenPipeline.

◆ MarkOutputsGenerated()

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

overrideprotectedvirtual

Reimplemented from vtkDemandDrivenPipeline.

◆ ResetPipelineInformation()

void vtkStreamingDemandDrivenPipeline::ResetPipelineInformation	(	int	port,
		vtkInformation *
	)

overrideprotectedvirtual

Reimplemented from vtkDemandDrivenPipeline.

Member Data Documentation

◆ ContinueExecuting

int vtkStreamingDemandDrivenPipeline::ContinueExecuting

protected

Definition at line 447 of file vtkStreamingDemandDrivenPipeline.h.

◆ UpdateExtentRequest

vtkInformation* vtkStreamingDemandDrivenPipeline::UpdateExtentRequest

protected

Definition at line 449 of file vtkStreamingDemandDrivenPipeline.h.

◆ UpdateTimeRequest

vtkInformation* vtkStreamingDemandDrivenPipeline::UpdateTimeRequest

protected

Definition at line 450 of file vtkStreamingDemandDrivenPipeline.h.

◆ TimeDependentInformationRequest

vtkInformation* vtkStreamingDemandDrivenPipeline::TimeDependentInformationRequest

protected

Definition at line 451 of file vtkStreamingDemandDrivenPipeline.h.

◆ InformationIterator

vtkInformationIterator* vtkStreamingDemandDrivenPipeline::InformationIterator

protected

Definition at line 452 of file vtkStreamingDemandDrivenPipeline.h.

◆ LastPropogateUpdateExtentShortCircuited

int vtkStreamingDemandDrivenPipeline::LastPropogateUpdateExtentShortCircuited

protected

Definition at line 455 of file vtkStreamingDemandDrivenPipeline.h.

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

Common/ExecutionModel/vtkStreamingDemandDrivenPipeline.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ NO_PRIOR_TEMPORAL_ACCESS_STATES

Constructor & Destructor Documentation

◆ vtkStreamingDemandDrivenPipeline()

◆ ~vtkStreamingDemandDrivenPipeline()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ ProcessRequest()

◆ Update() [1/3]

◆ Update() [2/3]

◆ UpdateWholeExtent()

◆ Update() [3/3]

◆ PropagateUpdateExtent()

◆ PropagateTime()

◆ UpdateTimeDependentInformation()

◆ SetWholeExtent()

◆ GetWholeExtent() [1/2]

◆ GetWholeExtent() [2/2]

◆ SetRequestExactExtent()

◆ GetRequestExactExtent()

◆ NO_PRIOR_TEMPORAL_ACCESS()

◆ GetUpdateExtent() [1/2]

◆ GetUpdateExtent() [2/2]

◆ GetUpdatePiece()

◆ GetUpdateNumberOfPieces()

◆ GetUpdateGhostLevel()

◆ NeedToExecuteBasedOnTime()

◆ ExecuteInformation()

◆ CopyDefaultInformation()

◆ VerifyOutputInformation()

◆ NeedToExecuteData()

◆ ExecuteDataStart()

◆ ExecuteDataEnd()

◆ MarkOutputsGenerated()

◆ ResetPipelineInformation()

Member Data Documentation

◆ ContinueExecuting

◆ UpdateExtentRequest

◆ UpdateTimeRequest

◆ TimeDependentInformationRequest

◆ InformationIterator

◆ LastPropogateUpdateExtentShortCircuited