Superclass for algorithms that operate on vtkMolecules. More...
#include <vtkMoleculeAlgorithm.h>
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 40 of file vtkMoleculeAlgorithm.h.
Member Typedef Documentation
Reimplemented from vtkAlgorithm.
Reimplemented in vtkSimpleBondPerceiver.
Definition at line 44 of file vtkMoleculeAlgorithm.h.
Constructor & Destructor Documentation
| vtkMoleculeAlgorithm::vtkMoleculeAlgorithm | ( | ) | [protected] |
| vtkMoleculeAlgorithm::~vtkMoleculeAlgorithm | ( | ) | [protected] |
Member Function Documentation
| static vtkMoleculeAlgorithm* vtkMoleculeAlgorithm::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkSimpleBondPerceiver.
| virtual const char* vtkMoleculeAlgorithm::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkSimpleBondPerceiver.
| 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.
| 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.
| static vtkMoleculeAlgorithm* vtkMoleculeAlgorithm::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkSimpleBondPerceiver.
| 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.
| vtkMolecule* vtkMoleculeAlgorithm::GetOutput | ( | ) |
Get the output data object for a port on this algorithm.
| vtkMolecule* vtkMoleculeAlgorithm::GetOutput | ( | int | ) |
Get the output data object for a port on this algorithm.
| virtual void vtkMoleculeAlgorithm::SetOutput | ( | vtkDataObject * | d | ) | [virtual] |
Get the output data object for a port on this algorithm.
| virtual int vtkMoleculeAlgorithm::ProcessRequest | ( | vtkInformation * | , |
| vtkInformationVector ** | , | ||
| vtkInformationVector * | |||
| ) | [virtual] |
see vtkAlgorithm for details
Reimplemented from vtkAlgorithm.
| vtkDataObject* vtkMoleculeAlgorithm::GetInput | ( | ) |
| vtkDataObject* vtkMoleculeAlgorithm::GetInput | ( | int | port | ) |
| vtkMolecule* vtkMoleculeAlgorithm::GetMoleculeInput | ( | int | port | ) |
| void vtkMoleculeAlgorithm::SetInput | ( | vtkDataObject * | ) |
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.
| void vtkMoleculeAlgorithm::SetInput | ( | int | , |
| vtkDataObject * | |||
| ) |
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.
| void vtkMoleculeAlgorithm::AddInput | ( | vtkDataObject * | ) |
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 SetInput() for details.
| void vtkMoleculeAlgorithm::AddInput | ( | int | , |
| vtkDataObject * | |||
| ) |
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 SetInput() 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.
| virtual int vtkMoleculeAlgorithm::RequestUpdateExtent | ( | vtkInformation * | , |
| vtkInformationVector ** | , | ||
| vtkInformationVector * | |||
| ) | [protected, virtual] |
This is called by the superclass. This is the method you should override.
| virtual void vtkMoleculeAlgorithm::ExecuteData | ( | vtkDataObject * | output | ) | [protected, virtual] |
This method is the old style execute method
| virtual void vtkMoleculeAlgorithm::Execute | ( | ) | [protected, virtual] |
This method is the old style execute method
| 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.
| 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:
- dox/Chemistry/vtkMoleculeAlgorithm.h
