#include "vtkCommonExecutionModelModule.h"
#include "vtkObject.h"
#include "vtkWrappingHints.h"

Include dependency graph for vtkAlgorithm.h:

This graph shows which files directly or indirectly include this file:

Classes
class	vtkAlgorithm
	Superclass for all sources, filters, and sinks in VTK. More...

Enumerations
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...

Functions
vtkAlgorithm vtkObject	RemoveNoPriorTemporalAccessInformationKey ()
	Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.
static vtkAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
virtual vtkTypeBool	IsA (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
virtual vtkObjectBase *	NewInstanceInternal () const
vtkAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
vtkTypeBool	HasExecutive ()
	Check whether this algorithm has an assigned executive.
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.
virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.
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	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.
vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.
int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.
int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.
void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.
void	UpdateProgress (double amount)
	Update the progress of the process object.
bool	CheckAbort ()
	Checks to see if this filter should abort.
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static vtkInformationIntegerKey *	ABORTED ()
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
void	RemoveAllInputs ()
	Remove all the input data.
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.
virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.
virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.
virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0).
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0).
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.
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).
virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS void	UpdateInformation ()
	Bring the algorithm's information up-to-date.
virtual void	UpdateDataObject ()
	Create output object(s).
virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.
virtual VTK_UNBLOCKTHREADS void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
	vtkAlgorithm ()
	~vtkAlgorithm () override
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
bool	CheckUpstreamAbort ()
	Checks to see if an upstream filter has been aborted.
virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.
virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.
virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
*int	GetInputArrayAssociation (int idx, vtkDataObject *input)
*vtkDataArray	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
*vtkDataArray	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
*vtkAbstractArray	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
*vtkAbstractArray	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.
void	ReportReferences (vtkGarbageCollector *) override
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.
virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.
void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.
void	AddInputDataInternal (int port, vtkDataObject *input)

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.

bool	UsesGarbageCollector () const override
	Participate in garbage collection.

virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.

virtual double	GetProgress ()
	Get the execution progress of a process object.

void	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm.
vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm.

virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive.
virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive.

void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.
virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.

void	SetInputArrayToProcess (const char *name, int fieldAssociation)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual VTK_UNBLOCKTHREADS void	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual VTK_UNBLOCKTHREADS void	Update ()
	Bring this algorithm's outputs up-to-date.

virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports.
virtual vtkTypeBool	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.
int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

Variables
std::atomic< vtkTypeBool >	AbortExecute
static vtkTimeStamp	LastAbortTime
vtkTimeStamp	LastAbortCheckTime
vtkInformation *	Information
*unsigned long	ErrorCode
*double	Progress
char *	ProgressText
static vtkExecutive *	DefaultExecutivePrototype
vtkProgressObserver *	ProgressObserver

Enumeration Type Documentation

◆ DesiredOutputPrecision

enum DesiredOutputPrecision

Values used for setting the desired output precision for various algorithms.

Currently, the following algorithms support changing their output precision: vtkAppendPolyData, vtkCleanPolyData, vtkClipPolyData, vtkConnectivityFilter, vtkDecimatePolylineFilter, vtkDecimatePro, vtkDelaunay3D, vtkFeatureEdges, vtkGlyph3D, vtkHedgeHog, vtkMaskPoints, vtkPolyDataConnectivityFilter, vtkSmoothPolyDataFilter, vtkStaticCleanPolyData, vtkThresholdPoints, vtkTubeFilter, vtkAppendPoints, vtkTransformFilter, vtkTransformPolyDataFilter, vtkLinearToQuadraticCellsFilter, vtkProcrustesAlignmentFilter, vtkAdaptiveSubdivisionFilter, vtkBoundedPointSource, vtkArcSource, vtkConeSource, vtkCubeSource, vtkCylinderSource, vtkDiskSource, vtkEllipseArcSource, vtkEllipticalButtonSource, vtkFrustumSource, vtkGlyphSource2D, vtkLineSource, vtkOutlineSource, vtkParametricFunctionSource, vtkPlaneSource, vtkPlatonicSolidSource, vtkPointSource, vtkRectangularButtonSource, vtkRegularPolygonSource, vtkSphereSource, vtkSuperquadricSource, vtkTessellatedBoxSource, vtkTextSource, vtkTexturedSphereSource, vtkImageToPoints, vtkDepthImageToPointCloud. SINGLE_PRECISION - Output single-precision floating-point (i.e. float) DOUBLE_PRECISION - Output double-precision floating-point (i.e. double) DEFAULT_PRECISION - Output precision should match the input precision.

Enumerator
SINGLE_PRECISION
DOUBLE_PRECISION
DEFAULT_PRECISION

Definition at line 25 of file vtkAlgorithm.h.

Function Documentation

◆ RemoveNoPriorTemporalAccessInformationKey()

vtkAlgorithm vtkObject RemoveNoPriorTemporalAccessInformationKey ( )

Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.

◆ New()

vtkAlgorithm * RemoveNoPriorTemporalAccessInformationKey::New ( )

static

◆ IsTypeOf()

vtkTypeBool RemoveNoPriorTemporalAccessInformationKey::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool RemoveNoPriorTemporalAccessInformationKey::IsA ( const char * type )

virtual

◆ SafeDownCast()

vtkAlgorithm * RemoveNoPriorTemporalAccessInformationKey::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * RemoveNoPriorTemporalAccessInformationKey::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkAlgorithm * RemoveNoPriorTemporalAccessInformationKey::NewInstance ( ) const

◆ PrintSelf()

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

override

◆ HasExecutive()

vtkTypeBool RemoveNoPriorTemporalAccessInformationKey::HasExecutive ( )

Check whether this algorithm has an assigned executive.

This will NOT create a default executive.

◆ GetExecutive()

vtkExecutive * RemoveNoPriorTemporalAccessInformationKey::GetExecutive ( )

Get this algorithm's executive.

If it has none, a default executive will be created.

◆ SetExecutive()

virtual void RemoveNoPriorTemporalAccessInformationKey::SetExecutive ( vtkExecutive * executive )

virtual

Set this algorithm's executive.

This algorithm is removed from any executive to which it has previously been assigned and then assigned to the given executive.

◆ ProcessRequest() [1/2]

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

virtual

Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

Upstream requests correspond to information flow from the algorithm's outputs to its inputs. Downstream requests correspond to information flow from the algorithm's inputs to its outputs.

A downstream request is defined by the contents of the request information object. The input to the request is stored in the input information vector passed to ProcessRequest. The results of an downstream request are stored in the output information vector passed to ProcessRequest.

An upstream request is defined by the contents of the request information object. The input to the request is stored in the output information vector passed to ProcessRequest. The results of an upstream request are stored in the input information vector passed to ProcessRequest.

It returns the boolean status of the pipeline (false means failure).

◆ ProcessRequest() [2/2]

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

Version of ProcessRequest() that is wrapped.

This converts the collection to an array and calls the other version.

◆ ComputePipelineMTime()

virtual int RemoveNoPriorTemporalAccessInformationKey::ComputePipelineMTime	(	vtkInformation *	request,
		vtkInformationVector **	inInfoVec,
		vtkInformationVector *	outInfoVec,
		int	requestFromOutputPort,
		vtkMTimeType *	mtime )

virtual

A special version of ProcessRequest meant specifically for the pipeline modified time request.

See vtkExecutive::ComputePipelineMTime() for details.

◆ ModifyRequest()

virtual int RemoveNoPriorTemporalAccessInformationKey::ModifyRequest	(	vtkInformation *	request,
		int	when )

virtual

This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.

The default implementation is empty. Returns 1 on success, 0 on failure. When can be either vtkExecutive::BeforeForward or vtkExecutive::AfterForward.

◆ GetInputPortInformation()

vtkInformation * RemoveNoPriorTemporalAccessInformationKey::GetInputPortInformation ( int port )

Get the information object associated with an input port.

There is one input port per kind of input to the algorithm. Each input port tells executives what kind of data and downstream requests this algorithm can handle for that input.

◆ GetOutputPortInformation()

vtkInformation * RemoveNoPriorTemporalAccessInformationKey::GetOutputPortInformation ( int port )

Get the information object associated with an output port.

There is one output port per output from the algorithm. Each output port tells executives what kind of upstream requests this algorithm can handle for that output.

◆ GetInformation()

virtual vtkInformation * RemoveNoPriorTemporalAccessInformationKey::GetInformation ( )

virtual

Set/Get the information object associated with this algorithm.

◆ SetInformation()

virtual void RemoveNoPriorTemporalAccessInformationKey::SetInformation ( vtkInformation * )

virtual

Set/Get the information object associated with this algorithm.

◆ GetNumberOfInputPorts()

int RemoveNoPriorTemporalAccessInformationKey::GetNumberOfInputPorts ( )

Get the number of input ports used by the algorithm.

◆ GetNumberOfOutputPorts()

int RemoveNoPriorTemporalAccessInformationKey::GetNumberOfOutputPorts ( )

Get the number of output ports provided by the algorithm.

◆ UsesGarbageCollector()

bool RemoveNoPriorTemporalAccessInformationKey::UsesGarbageCollector ( ) const

override

Participate in garbage collection.

Definition at line 139 of file vtkAlgorithm.h.

◆ SetAbortExecuteAndUpdateTime()

void RemoveNoPriorTemporalAccessInformationKey::SetAbortExecuteAndUpdateTime ( )

Set AbortExecute Flag and update LastAbortTime.

◆ SetAbortExecute()

virtual void RemoveNoPriorTemporalAccessInformationKey::SetAbortExecute ( vtkTypeBool )

virtual

Set/Get the AbortExecute flag for the process object.

Process objects may handle premature termination of execution in different ways.

◆ GetAbortExecute()

virtual vtkTypeBool RemoveNoPriorTemporalAccessInformationKey::GetAbortExecute ( )

virtual

Set/Get the AbortExecute flag for the process object.

Process objects may handle premature termination of execution in different ways.

◆ AbortExecuteOn()

virtual void RemoveNoPriorTemporalAccessInformationKey::AbortExecuteOn ( )

virtual

Set/Get the AbortExecute flag for the process object.

Process objects may handle premature termination of execution in different ways.

◆ AbortExecuteOff()

virtual void RemoveNoPriorTemporalAccessInformationKey::AbortExecuteOff ( )

virtual

Set/Get the AbortExecute flag for the process object.

Process objects may handle premature termination of execution in different ways.

◆ GetProgress()

virtual double RemoveNoPriorTemporalAccessInformationKey::GetProgress ( )

virtual

Get the execution progress of a process object.

◆ UpdateProgress()

void RemoveNoPriorTemporalAccessInformationKey::UpdateProgress ( double amount )

Update the progress of the process object.

If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

◆ CheckAbort()

bool RemoveNoPriorTemporalAccessInformationKey::CheckAbort ( )

Checks to see if this filter should abort.

◆ SetContainerAlgorithm()

void RemoveNoPriorTemporalAccessInformationKey::SetContainerAlgorithm ( vtkAlgorithm * containerAlg )

Set/get a Container algorithm for this algorithm.

Allows this algorithm to check to abort status of its Container algorithm as well as have access to its Container's information.

Definition at line 182 of file vtkAlgorithm.h.

◆ GetContainerAlgorithm()

vtkAlgorithm * RemoveNoPriorTemporalAccessInformationKey::GetContainerAlgorithm ( )

Set/get a Container algorithm for this algorithm.

Allows this algorithm to check to abort status of its Container algorithm as well as have access to its Container's information.

Definition at line 186 of file vtkAlgorithm.h.

◆ SetAbortOutput()

virtual void RemoveNoPriorTemporalAccessInformationKey::SetAbortOutput ( bool )

virtual

Set/Get an internal variable used to communicate between the algorithm and executive.

If the executive sees this value is set, it will initialize the output data and pass the ABORTED flag downstream.

CheckAbort sets this value to true if the function returns true.

◆ GetAbortOutput()

virtual bool RemoveNoPriorTemporalAccessInformationKey::GetAbortOutput ( )

virtual

Set/Get an internal variable used to communicate between the algorithm and executive.

If the executive sees this value is set, it will initialize the output data and pass the ABORTED flag downstream.

CheckAbort sets this value to true if the function returns true.

◆ SetProgressShiftScale()

void RemoveNoPriorTemporalAccessInformationKey::SetProgressShiftScale	(	double	shift,
		double	scale )

Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.

By default shift is set to 0, and scale is set to 1.0. This is useful when the vtkAlgorithm instance is used as an internal algorithm to solve only a part of a whole problem.

If calling on a internal vtkAlgorithm, make sure you take into consideration that values set of the outer vtkAlgorithm as well since the outer vtkAlgorithm itself may be nested in another algorithm.

Note: SetProgressShiftScale does not modify the MTime of the algorithm.

◆ GetProgressShift()

virtual double RemoveNoPriorTemporalAccessInformationKey::GetProgressShift ( )

virtual

Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.

By default shift is set to 0, and scale is set to 1.0. This is useful when the vtkAlgorithm instance is used as an internal algorithm to solve only a part of a whole problem.

If calling on a internal vtkAlgorithm, make sure you take into consideration that values set of the outer vtkAlgorithm as well since the outer vtkAlgorithm itself may be nested in another algorithm.

Note: SetProgressShiftScale does not modify the MTime of the algorithm.

◆ GetProgressScale()

virtual double RemoveNoPriorTemporalAccessInformationKey::GetProgressScale ( )

virtual

Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.

By default shift is set to 0, and scale is set to 1.0. This is useful when the vtkAlgorithm instance is used as an internal algorithm to solve only a part of a whole problem.

If calling on a internal vtkAlgorithm, make sure you take into consideration that values set of the outer vtkAlgorithm as well since the outer vtkAlgorithm itself may be nested in another algorithm.

Note: SetProgressShiftScale does not modify the MTime of the algorithm.

◆ SetProgressText()

void RemoveNoPriorTemporalAccessInformationKey::SetProgressText ( const char * ptext )

Set the current text message associated with the progress state.

This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().

◆ GetProgressText()

virtual char * RemoveNoPriorTemporalAccessInformationKey::GetProgressText ( )

virtual

Set the current text message associated with the progress state.

This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().

◆ GetErrorCode()

virtual unsigned long RemoveNoPriorTemporalAccessInformationKey::GetErrorCode ( )

virtual

The error code contains a possible error that occurred while reading or writing the file.

◆ SetInputArrayToProcess() [1/5]

void RemoveNoPriorTemporalAccessInformationKey::SetInputArrayToProcess	(	const char *	name,
		int	fieldAssociation )

Set the input data arrays that this algorithm will process.

Default to SetInputArrayToProcess(0, 0, 0, fieldAssociation, name)

Parameters

name	the name of the array to process
fieldAssociation	the field in the data object where the array is stored. See vtkDataObject::FieldAssociations for detail.

See also: void SetInputArrayToProcess(int, int, int, int, const char*)

◆ SetInputArrayToProcess() [2/5]

virtual void RemoveNoPriorTemporalAccessInformationKey::SetInputArrayToProcess	(	int	idx,
		int	port,
		int	connection,
		int	fieldAssociation,
		const char *	name )

virtual

Set the input data arrays that this algorithm will process.

Array is expected to be in the input data object specified by (port, connection), and is stored under the given fieldAssociation with given name Internally, this algorithm references it at idx position.

Full signature with array name.

Parameters

idx	the intern index of the array, in vtkAlgorithm scope. Useful for algorithm expecting different arrays to work.
port	the algorithm input port of the data object where to look for the requested array. See GetInputDataObject
connection	the algorithm input connection of the data object where to look for the requested array. See GetInputDataObject
fieldAssociation	the field in the data object where the array is stored. See vtkDataObject::FieldAssociations for detail.
name	the name of the array to process

◆ SetInputArrayToProcess() [3/5]

virtual void RemoveNoPriorTemporalAccessInformationKey::SetInputArrayToProcess	(	int	idx,
		int	port,
		int	connection,
		int	fieldAssociation,
		int	fieldAttributeType )

virtual

Set the input data arrays that this algorithm will process.

Full signature with attribute type.

Parameters

idx	the intern index of the array, in vtkAlgorithm scope. Useful for algorithm expecting different arrays to work.
port	the algorithm input port of the data object where to look for the requested array. See GetInputDataObject
connection	the algorithm input connection of the data object where to look for the requested array. See GetInputDataObject
fieldAssociation	the field in the data object where the array is stored. See vtkDataObject::FieldAssociations for detail.
fieldAttributeType	the attribute type related to the array to use. See vtkDataSetAttributes::AttributeTypes for possible values.

◆ SetInputArrayToProcess() [4/5]

virtual void RemoveNoPriorTemporalAccessInformationKey::SetInputArrayToProcess	(	int	idx,
		vtkInformation *	info )

virtual

Set the input data arrays that this algorithm will process.

Alternative variant that copy information into relevant InputArrayInformation. See GetInputArrayInformation

◆ SetInputArrayToProcess() [5/5]

virtual void RemoveNoPriorTemporalAccessInformationKey::SetInputArrayToProcess	(	int	idx,
		int	port,
		int	connection,
		const char *	fieldAssociation,
		const char *	attributeTypeorName )

virtual

Set the input data arrays that this algorithm will process.

String based version of SetInputArrayToProcess(). Because fieldAssociation and fieldAttributeType are enums, they cannot be easily accessed from scripting language. These methods provides an easy and safe way of passing association and attribute type information.

Field association is one of the following:

Attribute type is one of the following:

If the last argument is not an attribute type, it is assumed to be an array name.

See also: void SetInputArrayToProcess(int, int, int, int, int)

◆ GetInputArrayInformation()

vtkInformation * RemoveNoPriorTemporalAccessInformationKey::GetInputArrayInformation ( int idx )

Get the info object for the specified input array to this algorithm.

◆ RemoveAllInputs()

void RemoveNoPriorTemporalAccessInformationKey::RemoveAllInputs ( )

Remove all the input data.

◆ GetOutputDataObject()

vtkDataObject * RemoveNoPriorTemporalAccessInformationKey::GetOutputDataObject ( int port )

Get the data object that will contain the algorithm output for the given port.

◆ GetInputDataObject()

vtkDataObject * RemoveNoPriorTemporalAccessInformationKey::GetInputDataObject	(	int	port,
		int	connection )

Get the data object that will contain the algorithm input for the given port and given connection.

◆ SetInputConnection() [1/2]

virtual void RemoveNoPriorTemporalAccessInformationKey::SetInputConnection	(	int	port,
		vtkAlgorithmOutput *	input )

virtual

Set the connection for the given input port index.

Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().

The input for the connection is the output port of another filter, which is obtained with GetOutputPort(). Typical usage is

filter2->SetInputConnection(0, filter1->GetOutputPort(0)).

◆ SetInputConnection() [2/2]

virtual void RemoveNoPriorTemporalAccessInformationKey::SetInputConnection ( vtkAlgorithmOutput * input )

virtual

Set the connection for the given input port index.

Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().

The input for the connection is the output port of another filter, which is obtained with GetOutputPort(). Typical usage is

filter2->SetInputConnection(0, filter1->GetOutputPort(0)).

◆ AddInputConnection() [1/2]

virtual void RemoveNoPriorTemporalAccessInformationKey::AddInputConnection	(	int	port,
		vtkAlgorithmOutput *	input )

virtual

Add a connection to the given input port index.

See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is

filter2->AddInputConnection(0, filter1->GetOutputPort(0)).

◆ AddInputConnection() [2/2]

virtual void RemoveNoPriorTemporalAccessInformationKey::AddInputConnection ( vtkAlgorithmOutput * input )

virtual

Add a connection to the given input port index.

See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is

filter2->AddInputConnection(0, filter1->GetOutputPort(0)).

◆ RemoveInputConnection() [1/2]

virtual void RemoveNoPriorTemporalAccessInformationKey::RemoveInputConnection	(	int	port,
		vtkAlgorithmOutput *	input )

virtual

Remove a connection from the given input port index.

See SetInputConnection() for details on input connection. This method is the complement to AddInputConnection() in that it removes only the connection specified without affecting other connections. Typical usage is

filter2->RemoveInputConnection(0, filter1->GetOutputPort(0)).

◆ RemoveInputConnection() [2/2]

virtual void RemoveNoPriorTemporalAccessInformationKey::RemoveInputConnection	(	int	port,
		int	idx )

virtual

Remove a connection given by index idx.

◆ RemoveAllInputConnections()

virtual void RemoveNoPriorTemporalAccessInformationKey::RemoveAllInputConnections ( int port )

virtual

Removes all input connections.

◆ SetInputDataObject() [1/2]

virtual void RemoveNoPriorTemporalAccessInformationKey::SetInputDataObject	(	int	port,
		vtkDataObject *	data )

virtual

Sets the data-object as an input on the given port index.

Setting the input with this method removes all other connections from the port. Internally, this method creates a vtkTrivialProducer instance and sets that as the input-connection for the given port. It is safe to call this method repeatedly with the same input data object. The MTime of the vtkAlgorithm will not change unless the data object changed.

◆ SetInputDataObject() [2/2]

virtual void RemoveNoPriorTemporalAccessInformationKey::SetInputDataObject ( vtkDataObject * data )

virtual

Definition at line 473 of file vtkAlgorithm.h.

◆ AddInputDataObject() [1/2]

virtual void RemoveNoPriorTemporalAccessInformationKey::AddInputDataObject	(	int	port,
		vtkDataObject *	data )

virtual

Add the data-object as an input to this given port.

This will add a new input connection on the specified port without affecting any existing connections on the same input port.

◆ AddInputDataObject() [2/2]

virtual void RemoveNoPriorTemporalAccessInformationKey::AddInputDataObject ( vtkDataObject * data )

virtual

Definition at line 481 of file vtkAlgorithm.h.

◆ GetOutputPort() [1/2]

vtkAlgorithmOutput * RemoveNoPriorTemporalAccessInformationKey::GetOutputPort ( int index )

Get a proxy object corresponding to the given output port of this algorithm.

The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity.

◆ GetOutputPort() [2/2]

vtkAlgorithmOutput * RemoveNoPriorTemporalAccessInformationKey::GetOutputPort ( )

Definition at line 490 of file vtkAlgorithm.h.

◆ GetNumberOfInputConnections()

int RemoveNoPriorTemporalAccessInformationKey::GetNumberOfInputConnections ( int port )

Get the number of inputs currently connected to a port.

◆ GetTotalNumberOfInputConnections()

int RemoveNoPriorTemporalAccessInformationKey::GetTotalNumberOfInputConnections ( )

Get the total number of inputs for this algorithm.

◆ GetInputConnection()

vtkAlgorithmOutput * RemoveNoPriorTemporalAccessInformationKey::GetInputConnection	(	int	port,
		int	index )

Get the algorithm output port connected to an input port.

◆ GetInputAlgorithm() [1/3]

vtkAlgorithm * RemoveNoPriorTemporalAccessInformationKey::GetInputAlgorithm	(	int	port,
		int	index,
		int &	algPort )

Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

◆ GetInputAlgorithm() [2/3]

vtkAlgorithm * RemoveNoPriorTemporalAccessInformationKey::GetInputAlgorithm	(	int	port,
		int	index )

Returns the algorithm connected to a port-index pair.

◆ GetInputAlgorithm() [3/3]

vtkAlgorithm * RemoveNoPriorTemporalAccessInformationKey::GetInputAlgorithm ( )

Equivalent to GetInputAlgorithm(0, 0).

Definition at line 521 of file vtkAlgorithm.h.

◆ GetInputExecutive() [1/2]

vtkExecutive * RemoveNoPriorTemporalAccessInformationKey::GetInputExecutive	(	int	port,
		int	index )

Returns the executive associated with a particular input connection.

◆ GetInputExecutive() [2/2]

vtkExecutive * RemoveNoPriorTemporalAccessInformationKey::GetInputExecutive ( )

Equivalent to GetInputExecutive(0, 0).

Definition at line 532 of file vtkAlgorithm.h.

◆ GetInputInformation() [1/2]

vtkInformation * RemoveNoPriorTemporalAccessInformationKey::GetInputInformation	(	int	port,
		int	index )

Return the information object that is associated with a particular input connection.

This can be used to get meta-data coming from the REQUEST_INFORMATION pass and set requests for the REQUEST_UPDATE_EXTENT pass. NOTE: Do not use this in any of the pipeline passes. Use the information objects passed as arguments instead.

◆ GetInputInformation() [2/2]

vtkInformation * RemoveNoPriorTemporalAccessInformationKey::GetInputInformation ( )

Equivalent to GetInputInformation(0, 0).

Definition at line 547 of file vtkAlgorithm.h.

◆ GetOutputInformation()

vtkInformation * RemoveNoPriorTemporalAccessInformationKey::GetOutputInformation ( int port )

Return the information object that is associated with a particular output port.

This can be used to set meta-data coming during the REQUEST_INFORMATION. NOTE: Do not use this in any of the pipeline passes. Use the information objects passed as arguments instead.

◆ Update() [1/4]

virtual VTK_UNBLOCKTHREADS void RemoveNoPriorTemporalAccessInformationKey::Update ( int port )

virtual

Bring this algorithm's outputs up-to-date.

◆ Update() [2/4]

virtual VTK_UNBLOCKTHREADS void RemoveNoPriorTemporalAccessInformationKey::Update ( )

virtual

Bring this algorithm's outputs up-to-date.

◆ Update() [3/4]

virtual vtkTypeBool RemoveNoPriorTemporalAccessInformationKey::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:

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

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

◆ Update() [4/4]

virtual vtkTypeBool RemoveNoPriorTemporalAccessInformationKey::Update ( vtkInformation * requests )

virtual

Convenience method to update an algorithm after passing requests to its first output port.

See documentation for Update(int port, vtkInformationVector* requests) for details.

◆ UpdatePiece()

virtual int RemoveNoPriorTemporalAccessInformationKey::UpdatePiece	(	int	piece,
		int	numPieces,
		int	ghostLevels,
		const int	extents[6] = nullptr )

virtual

Convenience method to update an algorithm after passing requests to its first output port.

See documentation for Update(int port, vtkInformationVector* requests) for details. Supports piece and extent (optional) requests.

◆ UpdateExtent()

virtual VTK_UNBLOCKTHREADS int RemoveNoPriorTemporalAccessInformationKey::UpdateExtent ( const int extents[6] )

virtual

Convenience method to update an algorithm after passing requests to its first output port.

Supports extent request.

◆ UpdateTimeStep()

virtual VTK_UNBLOCKTHREADS int RemoveNoPriorTemporalAccessInformationKey::UpdateTimeStep	(	double	time,
		int	piece = -1,
		int	numPieces = 1,
		int	ghostLevels = 0,
		const int	extents[6] = nullptr )

virtual

Convenience method to update an algorithm after passing requests to its first output port.

See documentation for Update(int port, vtkInformationVector* requests) for details. Supports time, piece (optional) and extent (optional) requests.

◆ UpdateInformation()

virtual VTK_UNBLOCKTHREADS void RemoveNoPriorTemporalAccessInformationKey::UpdateInformation ( )

virtual

Bring the algorithm's information up-to-date.

◆ UpdateDataObject()

virtual void RemoveNoPriorTemporalAccessInformationKey::UpdateDataObject ( )

virtual

Create output object(s).

◆ PropagateUpdateExtent()

virtual void RemoveNoPriorTemporalAccessInformationKey::PropagateUpdateExtent ( )

virtual

Propagate meta-data upstream.

◆ UpdateWholeExtent()

virtual VTK_UNBLOCKTHREADS void RemoveNoPriorTemporalAccessInformationKey::UpdateWholeExtent ( )

virtual

Bring this algorithm's outputs up-to-date.

◆ ConvertTotalInputToPortConnection()

void RemoveNoPriorTemporalAccessInformationKey::ConvertTotalInputToPortConnection	(	int	ind,
		int &	port,
		int &	conn )

Convenience routine to convert from a linear ordering of input connections to a port/connection pair.

◆ SetReleaseDataFlag()

virtual void RemoveNoPriorTemporalAccessInformationKey::SetReleaseDataFlag ( vtkTypeBool )

virtual

Turn release data flag on or off for all output ports.

◆ GetReleaseDataFlag()

virtual vtkTypeBool RemoveNoPriorTemporalAccessInformationKey::GetReleaseDataFlag ( )

virtual

Turn release data flag on or off for all output ports.

◆ ReleaseDataFlagOn()

void RemoveNoPriorTemporalAccessInformationKey::ReleaseDataFlagOn ( )

Turn release data flag on or off for all output ports.

◆ ReleaseDataFlagOff()

void RemoveNoPriorTemporalAccessInformationKey::ReleaseDataFlagOff ( )

Turn release data flag on or off for all output ports.

◆ UpdateExtentIsEmpty() [1/2]

int RemoveNoPriorTemporalAccessInformationKey::UpdateExtentIsEmpty	(	vtkInformation *	pinfo,
		vtkDataObject *	output )

This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

The source uses this call to determine whether to call Execute.

◆ UpdateExtentIsEmpty() [2/2]

int RemoveNoPriorTemporalAccessInformationKey::UpdateExtentIsEmpty	(	vtkInformation *	pinfo,
		int	extentType )

This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

The source uses this call to determine whether to call Execute.

◆ SetDefaultExecutivePrototype()

void RemoveNoPriorTemporalAccessInformationKey::SetDefaultExecutivePrototype ( vtkExecutive * proto )

static

If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().