VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkMoleculeAlgorithm Class Reference

Superclass for algorithms that operate on vtkMolecules. More...

#include <vtkMoleculeAlgorithm.h>

Inheritance diagram for vtkMoleculeAlgorithm:
Inheritance graph
[legend]
Collaboration diagram for vtkMoleculeAlgorithm:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkMoleculeAlgorithmNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
vtkDataObjectGetInput ()
vtkDataObjectGetInput (int port)
vtkMoleculeGetMoleculeInput (int port)
vtkMoleculeGetOutput ()
vtkMoleculeGetOutput (int)
virtual void SetOutput (vtkMolecule *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInputData (vtkDataObject *)
void SetInputData (int, vtkDataObject *)
void AddInputData (vtkDataObject *)
void AddInputData (int, vtkDataObject *)

Static Public Member Functions

static vtkMoleculeAlgorithmNew ()
static int IsTypeOf (const char *type)
static vtkMoleculeAlgorithmSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkMoleculeAlgorithm ()
 ~vtkMoleculeAlgorithm ()
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 *)

Detailed Description

Superclass for algorithms that operate on vtkMolecules.

vtkMoleculeAlgorithm is a convenience class to make writing algorithms easier. 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 vtkMolecules. If that isn't the case then please override this method in your subclass. You should implement the subclass's algorithm into RequestData( request, inputVec, outputVec).

Definition at line 41 of file vtkMoleculeAlgorithm.h.


Member Typedef Documentation

Reimplemented from vtkAlgorithm.

Reimplemented in vtkSimpleBondPerceiver, and vtkCMLMoleculeReader.

Definition at line 45 of file vtkMoleculeAlgorithm.h.


Constructor & Destructor Documentation


Member Function Documentation

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkSimpleBondPerceiver, and vtkCMLMoleculeReader.

static int vtkMoleculeAlgorithm::IsTypeOf ( const char *  name) [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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkSimpleBondPerceiver, and vtkCMLMoleculeReader.

virtual int vtkMoleculeAlgorithm::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 vtkAlgorithm.

Reimplemented in vtkSimpleBondPerceiver, and vtkCMLMoleculeReader.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkSimpleBondPerceiver, and vtkCMLMoleculeReader.

virtual vtkObjectBase* vtkMoleculeAlgorithm::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkAlgorithm.

Reimplemented in vtkSimpleBondPerceiver, and vtkCMLMoleculeReader.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkSimpleBondPerceiver, and vtkCMLMoleculeReader.

void vtkMoleculeAlgorithm::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 vtkAlgorithm.

Reimplemented in vtkSimpleBondPerceiver, and vtkCMLMoleculeReader.

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

Reimplemented in vtkCMLMoleculeReader.

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

virtual void vtkMoleculeAlgorithm::SetOutput ( vtkMolecule d) [virtual]

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

Reimplemented in vtkCMLMoleculeReader.

see vtkAlgorithm for details

Reimplemented from vtkAlgorithm.

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.

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.

Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInputData() for details.

Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInputData() for details.

virtual int vtkMoleculeAlgorithm::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]
virtual int vtkMoleculeAlgorithm::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

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

Reimplemented in vtkSimpleBondPerceiver, and vtkCMLMoleculeReader.

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

virtual int vtkMoleculeAlgorithm::FillOutputPortInformation ( int  port,
vtkInformation info 
) [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 vtkAlgorithm.

Reimplemented in vtkCMLMoleculeReader.

virtual int vtkMoleculeAlgorithm::FillInputPortInformation ( int  port,
vtkInformation info 
) [protected, virtual]

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.


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