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

Superclass for algorithms that produce only graph as output. More...

#include <vtkGraphAlgorithm.h>

Inherits vtkAlgorithm.

Public Types

typedef vtkAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
vtkGraphGetOutput ()
 
vtkGraphGetOutput (int index)
 
void SetInput (vtkDataObject *obj)
 
void SetInput (int index, vtkDataObject *obj)
 

Static Public Member Functions

static vtkGraphAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGraphAlgorithmSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkGraphAlgorithm ()
 
 ~vtkGraphAlgorithm ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 

Detailed Description

Superclass for algorithms that produce only graph as output.

vtkGraphAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help transition old algorithms to the new pipeline architecture. There are some assumptions and defaults made by this class you should be aware of. This class defaults such that your filter will have one input port and one output port. If that is not the case simply change it with SetNumberOfInputPorts etc. See this class constructor for the default. This class also provides a FillInputPortInfo method that by default says that all inputs will be Graph. If that isn't the case then please override this method in your subclass. This class breaks out the downstream requests into separate functions such as ExecuteData and ExecuteInformation. For new algorithms you should implement RequestData( request, inputVec, outputVec) but for older filters there is a default implementation that calls the old ExecuteData(output) signature. For even older filters that don't implement ExecuteData the default implementation calls the even older Execute() signature.

Thanks:
Thanks to Patricia Crossno, Ken Moreland, Andrew Wilson and Brian Wylie from Sandia National Laboratories for their help in developing this class.
Tests:
vtkGraphAlgorithm (Tests)

Definition at line 56 of file vtkGraphAlgorithm.h.

Member Typedef Documentation

typedef vtkAlgorithm vtkGraphAlgorithm::Superclass

Definition at line 60 of file vtkGraphAlgorithm.h.

Constructor & Destructor Documentation

vtkGraphAlgorithm::vtkGraphAlgorithm ( )
protected
vtkGraphAlgorithm::~vtkGraphAlgorithm ( )
protected

Member Function Documentation

static vtkGraphAlgorithm* vtkGraphAlgorithm::New ( )
static
virtual const char* vtkGraphAlgorithm::GetClassName ( )
virtual
static int vtkGraphAlgorithm::IsTypeOf ( const char *  type)
static
virtual int vtkGraphAlgorithm::IsA ( const char *  type)
virtual
static vtkGraphAlgorithm* vtkGraphAlgorithm::SafeDownCast ( vtkObject o)
static
void vtkGraphAlgorithm::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual int vtkGraphAlgorithm::ProcessRequest ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
virtual

see vtkAlgorithm for details

vtkGraph* vtkGraphAlgorithm::GetOutput ( )
inline

Get the output data object for a port on this algorithm.

Definition at line 72 of file vtkGraphAlgorithm.h.

vtkGraph* vtkGraphAlgorithm::GetOutput ( int  index)

Get the output data object for a port on this algorithm.

void vtkGraphAlgorithm::SetInput ( vtkDataObject obj)
inline

Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.

Definition at line 84 of file vtkGraphAlgorithm.h.

void vtkGraphAlgorithm::SetInput ( int  index,
vtkDataObject obj 
)

Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.

virtual int vtkGraphAlgorithm::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual
virtual int vtkGraphAlgorithm::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

This is called by the superclass. This is the method you should override.

virtual int vtkGraphAlgorithm::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

This is called by the superclass. This is the method you should override.

virtual int vtkGraphAlgorithm::RequestDataObject ( vtkInformation ,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

By default, creates the same output type as the input type.

virtual int vtkGraphAlgorithm::FillOutputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual
virtual int vtkGraphAlgorithm::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

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