VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkMoleculeAlgorithm Class Reference

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

#include <vtkMoleculeAlgorithm.h>

Inheritance diagram for vtkMoleculeAlgorithm:
[legend]

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)
 
vtkMolecule * GetMoleculeInput (int port)
 
vtkMolecule * GetOutput ()
 
vtkMolecule * GetOutput (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

typedef vtkAlgorithm vtkMoleculeAlgorithm::Superclass

Definition at line 45 of file vtkMoleculeAlgorithm.h.

Constructor & Destructor Documentation

vtkMoleculeAlgorithm::vtkMoleculeAlgorithm ( )
protected
vtkMoleculeAlgorithm::~vtkMoleculeAlgorithm ( )
protected

Member Function Documentation

static vtkMoleculeAlgorithm* vtkMoleculeAlgorithm::New ( )
static
static int vtkMoleculeAlgorithm::IsTypeOf ( const char *  type)
static
virtual int vtkMoleculeAlgorithm::IsA ( const char *  type)
virtual
static vtkMoleculeAlgorithm* vtkMoleculeAlgorithm::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkMoleculeAlgorithm::NewInstanceInternal ( ) const
protectedvirtual
vtkMoleculeAlgorithm* vtkMoleculeAlgorithm::NewInstance ( ) const
void vtkMoleculeAlgorithm::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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 ( vtkMolecule *  d)
virtual

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

Reimplemented in vtkCMLMoleculeReader.

virtual int vtkMoleculeAlgorithm::ProcessRequest ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
virtual

see vtkAlgorithm for details

vtkDataObject* vtkMoleculeAlgorithm::GetInput ( )
vtkDataObject* vtkMoleculeAlgorithm::GetInput ( int  port)
vtkMolecule* vtkMoleculeAlgorithm::GetMoleculeInput ( int  port)
void vtkMoleculeAlgorithm::SetInputData ( 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::SetInputData ( 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::AddInputData ( 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 SetInputData() for details.

void vtkMoleculeAlgorithm::AddInputData ( 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 SetInputData() for details.

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

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

Reimplemented in vtkSimpleBondPerceiver, and vtkCMLMoleculeReader.

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

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

virtual int vtkMoleculeAlgorithm::FillOutputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

Reimplemented in vtkCMLMoleculeReader.

virtual int vtkMoleculeAlgorithm::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

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