vtkSource Class Reference

#include <vtkSource.h>

Inheritance diagram for vtkSource:

[legend]Collaboration diagram for vtkSource:

[legend]List of all members.

---

Detailed Description

abstract class specifies interface for visualization network source

vtkSource is an abstract object that specifies behavior and interface of source objects. Source objects are objects that begin visualization pipeline. Sources include readers (read data from file or communications port) and procedural sources (generate data programmatically). vtkSource objects are also objects that generate output data. In this sense vtkSource is used as a superclass to vtkFilter.

Concrete subclasses of vtkSource must define Update() and Execute() methods. The public method Update() invokes network execution and will bring the network up-to-date. The protected Execute() method actually does the work of data creation/generation. The difference between the two methods is that Update() implements input consistency checks and modified time comparisons and then invokes the Execute() which is an implementation of a particular algorithm.

An important feature of subclasses of vtkSource is that it is possible to control the memory-management model (i.e., retain output versus delete output data). If enabled the ReleaseDataFlag enables the deletion of the output data once the downstream process object finishes processing the data (please see text).

See also:

vtkProcessObject vtkDataSetReader vtkFilter vtkPolyDataSource vtkStructuredGridSource vtkStructuredPointsSource vtkUnstructuredGridSource

Events:

vtkCommand::ExecuteInformationEvent vtkCommand::SetOutputEvent

Definition at line 55 of file vtkSource.h.

Public Types
typedef vtkProcessObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Update ()
virtual void	UpdateWholeExtent ()
virtual void	UpdateInformation ()
virtual void	PropagateUpdateExtent (vtkDataObject *output)
virtual void	TriggerAsynchronousUpdate ()
virtual void	UpdateData (vtkDataObject *output)
void	UnRegisterAllOutputs (void)
int	GetOutputIndex (vtkDataObject *out)
virtual void	ComputeInputUpdateExtents (vtkDataObject *output)
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
virtual void	ReleaseDataFlagOn ()
virtual void	ReleaseDataFlagOff ()
vtkDataObject **	GetOutputs ()
virtual int	GetNumberOfOutputs ()
virtual void	SetExecutive (vtkExecutive *executive)
virtual int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkSource *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSource ()
	~vtkSource ()
virtual void	ExecuteData (vtkDataObject *output)
virtual void	Execute ()
virtual void	ExecuteInformation ()
virtual void	MarkGeneratedOutputs (vtkDataObject *)
void	SetNumberOfOutputs (int num)
vtkDataObject *	GetOutput (int idx)
virtual void	SetNthOutput (int num, vtkDataObject *output)
virtual void	AddOutput (vtkDataObject *output)
virtual void	RemoveOutput (vtkDataObject *output)
virtual void	ReportReferences (vtkGarbageCollector *)
int	FillOutputPortInformation (int, vtkInformation *)
virtual void	SetNumberOfOutputPorts (int n)
Protected Attributes
vtkDataObject **	Outputs
int	NumberOfOutputs
int	Updating
vtkTimeStamp	InformationTime
Friends
class	vtkDataObjectToSourceFriendship

---

Member Typedef Documentation

typedef vtkProcessObject vtkSource::Superclass

Reimplemented from vtkProcessObject. Reimplemented in vtkDataObjectSource, vtkDataSetSource, vtkDataSetToDataSetFilter, vtkDataSetToImageFilter, vtkDataSetToPolyDataFilter, vtkDataSetToStructuredGridFilter, vtkDataSetToStructuredPointsFilter, vtkDataSetToUnstructuredGridFilter, vtkImageMultipleInputFilter, vtkImageMultipleInputOutputFilter, vtkImageSource, vtkImageToImageFilter, vtkImageTwoInputFilter, vtkPointSetSource, vtkPointSetToPointSetFilter, vtkPolyDataSource, vtkPolyDataToPolyDataFilter, vtkRectilinearGridSource, vtkRectilinearGridToPolyDataFilter, vtkStructuredGridSource, vtkStructuredGridToPolyDataFilter, vtkStructuredGridToStructuredGridFilter, vtkStructuredPointsSource, vtkStructuredPointsToPolyDataFilter, vtkStructuredPointsToStructuredPointsFilter, vtkStructuredPointsToUnstructuredGridFilter, vtkUnstructuredGridSource, vtkUnstructuredGridToPolyDataFilter, vtkUnstructuredGridToUnstructuredGridFilter, vtkGenericProbeFilter, vtkSpatialRepresentationFilter, vtkImageSpatialFilter, vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, vtkEnSightGoldReader, vtkEnSightMasterServerReader, vtkEnSightReader, vtkGenericEnSightReader, and vtkPLOT3DReader. Definition at line 58 of file vtkSource.h.

---

Constructor & Destructor Documentation

vtkSource::vtkSource (   )  [protected]

vtkSource::~vtkSource (   )  [protected]

---

Member Function Documentation

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

Reimplemented from vtkProcessObject. Reimplemented in vtkDataObjectSource, vtkDataSetSource, vtkDataSetToDataSetFilter, vtkDataSetToImageFilter, vtkDataSetToPolyDataFilter, vtkDataSetToStructuredGridFilter, vtkDataSetToStructuredPointsFilter, vtkDataSetToUnstructuredGridFilter, vtkImageMultipleInputFilter, vtkImageMultipleInputOutputFilter, vtkImageSource, vtkImageToImageFilter, vtkImageTwoInputFilter, vtkPointSetSource, vtkPointSetToPointSetFilter, vtkPolyDataSource, vtkPolyDataToPolyDataFilter, vtkRectilinearGridSource, vtkRectilinearGridToPolyDataFilter, vtkStructuredGridSource, vtkStructuredGridToPolyDataFilter, vtkStructuredGridToStructuredGridFilter, vtkStructuredPointsSource, vtkStructuredPointsToPolyDataFilter, vtkStructuredPointsToStructuredPointsFilter, vtkStructuredPointsToUnstructuredGridFilter, vtkUnstructuredGridSource, vtkUnstructuredGridToPolyDataFilter, vtkUnstructuredGridToUnstructuredGridFilter, vtkGenericProbeFilter, vtkSpatialRepresentationFilter, vtkImageSpatialFilter, vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, vtkEnSightGoldReader, vtkEnSightMasterServerReader, vtkEnSightReader, vtkGenericEnSightReader, and vtkPLOT3DReader.

static int vtkSource::IsTypeOf (  const char *  type  )  [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkProcessObject. Reimplemented in vtkDataObjectSource, vtkDataSetSource, vtkDataSetToDataSetFilter, vtkDataSetToImageFilter, vtkDataSetToPolyDataFilter, vtkDataSetToStructuredGridFilter, vtkDataSetToStructuredPointsFilter, vtkDataSetToUnstructuredGridFilter, vtkImageMultipleInputFilter, vtkImageMultipleInputOutputFilter, vtkImageSource, vtkImageToImageFilter, vtkImageTwoInputFilter, vtkPointSetSource, vtkPointSetToPointSetFilter, vtkPolyDataSource, vtkPolyDataToPolyDataFilter, vtkRectilinearGridSource, vtkRectilinearGridToPolyDataFilter, vtkStructuredGridSource, vtkStructuredGridToPolyDataFilter, vtkStructuredGridToStructuredGridFilter, vtkStructuredPointsSource, vtkStructuredPointsToPolyDataFilter, vtkStructuredPointsToStructuredPointsFilter, vtkStructuredPointsToUnstructuredGridFilter, vtkUnstructuredGridSource, vtkUnstructuredGridToPolyDataFilter, vtkUnstructuredGridToUnstructuredGridFilter, vtkGenericProbeFilter, vtkSpatialRepresentationFilter, vtkImageSpatialFilter, vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, vtkEnSightGoldReader, vtkEnSightMasterServerReader, vtkEnSightReader, vtkGenericEnSightReader, and vtkPLOT3DReader.

virtual int vtkSource::IsA (  const char *  type  )  [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkProcessObject. Reimplemented in vtkDataObjectSource, vtkDataSetSource, vtkDataSetToDataSetFilter, vtkDataSetToImageFilter, vtkDataSetToPolyDataFilter, vtkDataSetToStructuredGridFilter, vtkDataSetToStructuredPointsFilter, vtkDataSetToUnstructuredGridFilter, vtkImageMultipleInputFilter, vtkImageMultipleInputOutputFilter, vtkImageSource, vtkImageToImageFilter, vtkImageTwoInputFilter, vtkPointSetSource, vtkPointSetToPointSetFilter, vtkPolyDataSource, vtkPolyDataToPolyDataFilter, vtkRectilinearGridSource, vtkRectilinearGridToPolyDataFilter, vtkStructuredGridSource, vtkStructuredGridToPolyDataFilter, vtkStructuredGridToStructuredGridFilter, vtkStructuredPointsSource, vtkStructuredPointsToPolyDataFilter, vtkStructuredPointsToStructuredPointsFilter, vtkStructuredPointsToUnstructuredGridFilter, vtkUnstructuredGridSource, vtkUnstructuredGridToPolyDataFilter, vtkUnstructuredGridToUnstructuredGridFilter, vtkGenericProbeFilter, vtkSpatialRepresentationFilter, vtkImageSpatialFilter, vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, vtkEnSightGoldReader, vtkEnSightMasterServerReader, vtkEnSightReader, vtkGenericEnSightReader, and vtkPLOT3DReader.

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

Reimplemented from vtkProcessObject. Reimplemented in vtkDataObjectSource, vtkDataSetSource, vtkDataSetToDataSetFilter, vtkDataSetToImageFilter, vtkDataSetToPolyDataFilter, vtkDataSetToStructuredGridFilter, vtkDataSetToStructuredPointsFilter, vtkDataSetToUnstructuredGridFilter, vtkImageMultipleInputFilter, vtkImageMultipleInputOutputFilter, vtkImageSource, vtkImageToImageFilter, vtkImageTwoInputFilter, vtkPointSetSource, vtkPointSetToPointSetFilter, vtkPolyDataSource, vtkPolyDataToPolyDataFilter, vtkRectilinearGridSource, vtkRectilinearGridToPolyDataFilter, vtkStructuredGridSource, vtkStructuredGridToPolyDataFilter, vtkStructuredGridToStructuredGridFilter, vtkStructuredPointsSource, vtkStructuredPointsToPolyDataFilter, vtkStructuredPointsToStructuredPointsFilter, vtkStructuredPointsToUnstructuredGridFilter, vtkUnstructuredGridSource, vtkUnstructuredGridToPolyDataFilter, vtkUnstructuredGridToUnstructuredGridFilter, vtkGenericProbeFilter, vtkSpatialRepresentationFilter, vtkImageSpatialFilter, vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, vtkEnSightGoldReader, vtkEnSightMasterServerReader, vtkEnSightReader, vtkGenericEnSightReader, and vtkPLOT3DReader.

void vtkSource::PrintSelf (  ostream &  os, vtkIndent  indent )  [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from vtkProcessObject. Reimplemented in vtkDataObjectSource, vtkDataSetSource, vtkDataSetToDataSetFilter, vtkDataSetToImageFilter, vtkDataSetToPolyDataFilter, vtkDataSetToStructuredGridFilter, vtkDataSetToStructuredPointsFilter, vtkDataSetToUnstructuredGridFilter, vtkImageMultipleInputFilter, vtkImageMultipleInputOutputFilter, vtkImageSource, vtkImageToImageFilter, vtkImageTwoInputFilter, vtkPointSetSource, vtkPointSetToPointSetFilter, vtkPolyDataSource, vtkPolyDataToPolyDataFilter, vtkRectilinearGridSource, vtkRectilinearGridToPolyDataFilter, vtkStructuredGridSource, vtkStructuredGridToPolyDataFilter, vtkStructuredGridToStructuredGridFilter, vtkStructuredPointsSource, vtkStructuredPointsToPolyDataFilter, vtkStructuredPointsToStructuredPointsFilter, vtkStructuredPointsToUnstructuredGridFilter, vtkUnstructuredGridSource, vtkUnstructuredGridToPolyDataFilter, vtkUnstructuredGridToUnstructuredGridFilter, vtkGenericProbeFilter, vtkSpatialRepresentationFilter, vtkImageSpatialFilter, vtkEnSight6BinaryReader, vtkEnSight6Reader, vtkEnSightGoldBinaryReader, vtkEnSightGoldReader, vtkEnSightMasterServerReader, vtkEnSightReader, vtkGenericEnSightReader, and vtkPLOT3DReader.

virtual void vtkSource::Update (   )  [virtual]

Bring object up-to-date before execution. Update() checks modified time against last execution time, and re-executes object if necessary. Reimplemented from vtkAlgorithm. Reimplemented in vtkEnSightReader, and vtkGenericEnSightReader.

virtual void vtkSource::UpdateWholeExtent (   )  [virtual]

Like update, but make sure the update extent is the whole extent in the output. Reimplemented from vtkAlgorithm.

virtual void vtkSource::UpdateInformation (   )  [virtual]

Updates any global information about the data (like spacing for images) Reimplemented from vtkAlgorithm.

virtual void vtkSource::PropagateUpdateExtent (  vtkDataObject *  output  )  [virtual]

virtual void vtkSource::TriggerAsynchronousUpdate (   )  [virtual]

virtual void vtkSource::UpdateData (  vtkDataObject *  output  )  [virtual]

virtual void vtkSource::ComputeInputUpdateExtents (  vtkDataObject *  output  )  [virtual]

What is the input update extent that is required to produce the desired output? By default, the whole input is always required but this is overridden in many subclasses. Reimplemented in vtkDataSetToDataSetFilter, vtkDataSetToImageFilter, vtkDataSetToPolyDataFilter, vtkDataSetToStructuredPointsFilter, vtkImageMultipleInputFilter, vtkImageMultipleInputOutputFilter, vtkImageToImageFilter, vtkPointSetToPointSetFilter, vtkPolyDataSource, vtkStructuredPointsToPolyDataFilter, vtkStructuredPointsToStructuredPointsFilter, vtkStructuredPointsToUnstructuredGridFilter, vtkUnstructuredGridSource, and vtkUnstructuredGridToPolyDataFilter.

virtual void vtkSource::SetReleaseDataFlag (  int   )  [virtual]

Turn on/off flag to control whether this object's data is released after being used by a source. Reimplemented from vtkAlgorithm.

virtual int vtkSource::GetReleaseDataFlag (   )  [virtual]

What is the input update extent that is required to produce the desired output? By default, the whole input is always required but this is overridden in many subclasses. Reimplemented from vtkAlgorithm.

virtual void vtkSource::ReleaseDataFlagOn (   )  [virtual]

What is the input update extent that is required to produce the desired output? By default, the whole input is always required but this is overridden in many subclasses. Reimplemented from vtkAlgorithm.

virtual void vtkSource::ReleaseDataFlagOff (   )  [virtual]

What is the input update extent that is required to produce the desired output? By default, the whole input is always required but this is overridden in many subclasses. Reimplemented from vtkAlgorithm.

vtkDataObject** vtkSource::GetOutputs (   )

Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc.

virtual int vtkSource::GetNumberOfOutputs (   )  [virtual]

Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc. Reimplemented in vtkPLOT3DReader. Referenced by vtkPLOT3DReader::GetNumberOfGrids().

void vtkSource::UnRegisterAllOutputs (  void   )

Release/disconnect all outputs of this source. This is intended to be called prior to Delete() if the user is concerned about outputs holding on to the filter/source.

int vtkSource::GetOutputIndex (  vtkDataObject *  out  )

Return what index output the passed in output is, return -1 if it does not match any of the outputs

virtual void vtkSource::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. Reimplemented from vtkAlgorithm.

virtual int vtkSource::ProcessRequest (  vtkInformation *  , vtkInformationVector **  , vtkInformationVector *  )  [virtual]

Transform pipeline requests from executives into old-style pipeline calls. This works with the vtkStreamingDemandDrivenPipeline executive to maintain backward compatibility for filters written as subclasses of vtkSource. Reimplemented from vtkAlgorithm. Reimplemented in vtkDataSetToDataSetFilter.

virtual void vtkSource::ExecuteData (  vtkDataObject *  output  )  [protected, virtual]

This method is the one that should be used by subclasses, right now the default implementation is to call the backwards compatibility method Reimplemented in vtkImageMultipleInputFilter, vtkImageMultipleInputOutputFilter, and vtkImageToImageFilter.

virtual void vtkSource::Execute (   )  [protected, virtual]

This method is the old style execute method Reimplemented in vtkImageSource, vtkGenericProbeFilter, vtkSpatialRepresentationFilter, vtkEnSightMasterServerReader, vtkEnSightReader, vtkGenericEnSightReader, and vtkPLOT3DReader.

virtual void vtkSource::ExecuteInformation (   )  [protected, virtual]

Reimplemented in vtkDataSetToDataSetFilter, vtkImageMultipleInputFilter, vtkImageMultipleInputOutputFilter, vtkImageToImageFilter, vtkStructuredPointsSource, vtkStructuredPointsToStructuredPointsFilter, vtkImageSpatialFilter, vtkEnSightMasterServerReader, vtkEnSightReader, vtkGenericEnSightReader, and vtkPLOT3DReader.

virtual void vtkSource::MarkGeneratedOutputs (  vtkDataObject *   )  [protected, virtual]

void vtkSource::SetNumberOfOutputs (  int  num  )  [protected]

vtkDataObject* vtkSource::GetOutput (  int  idx  )  [protected]

Reimplemented in vtkDataObjectSource, vtkDataSetSource, vtkDataSetToDataSetFilter, vtkImageMultipleInputOutputFilter, vtkImageSource, vtkPointSetSource, vtkPointSetToPointSetFilter, vtkPolyDataSource, vtkRectilinearGridSource, vtkStructuredGridSource, vtkStructuredPointsSource, vtkUnstructuredGridSource, and vtkSpatialRepresentationFilter. Referenced by vtkDataObjectSource::GetOutput().

virtual void vtkSource::SetNthOutput (  int  num, vtkDataObject *  output )  [protected, virtual]

virtual void vtkSource::AddOutput (  vtkDataObject *  output  )  [protected, virtual]

virtual void vtkSource::RemoveOutput (  vtkDataObject *  output  )  [protected, virtual]

virtual void vtkSource::ReportReferences (  vtkGarbageCollector *   )  [protected, virtual]

Reimplemented from vtkProcessObject. Reimplemented in vtkSpatialRepresentationFilter.

int vtkSource::FillOutputPortInformation (  int  , vtkInformation *  )  [protected, virtual]

Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle. Reimplemented from vtkProcessObject. Reimplemented in vtkDataObjectSource, vtkDataSetSource, vtkImageSource, vtkPointSetSource, vtkPolyDataSource, vtkRectilinearGridSource, vtkStructuredGridSource, vtkStructuredPointsSource, and vtkUnstructuredGridSource.

virtual void vtkSource::SetNumberOfOutputPorts (  int  n  )  [protected, virtual]

Set the number of output ports provided by the algorithm. Reimplemented from vtkAlgorithm.

---

Friends And Related Function Documentation

friend class vtkDataObjectToSourceFriendship [friend]

Definition at line 174 of file vtkSource.h.

---

Member Data Documentation

vtkDataObject** vtkSource::Outputs [protected]

Definition at line 158 of file vtkSource.h.

int vtkSource::NumberOfOutputs [protected]

Definition at line 159 of file vtkSource.h.

int vtkSource::Updating [protected]

Definition at line 160 of file vtkSource.h.

vtkTimeStamp vtkSource::InformationTime [protected]

Definition at line 162 of file vtkSource.h.

---

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

• dox/Filtering/vtkSource.h

---