Base class for filters that weight graph edges. More...
#include <vtkGraphWeightFilter.h>
Public Types | |
| typedef vtkGraphAlgorithm | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkGraphWeightFilter * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkGraphWeightFilter () | |
| ~vtkGraphWeightFilter () | |
| int | RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
| virtual float | ComputeWeight (vtkGraph *const graph, const vtkEdgeType &edge) const =0 |
| virtual bool | CheckRequirements (vtkGraph *const graph) const |
Detailed Description
Base class for filters that weight graph edges.
vtkGraphWeightFilter is the abstract base class that provides an interface for classes that apply weights to graph edges. The weights are added as a vtkFloatArray named "Weights." The ComputeWeight function must be implemented to provide the function of two vertices which determines the weight of each edge. The CheckRequirements function can be implemented if you wish to ensure that the input graph has all of the properties that will be required by the ComputeWeight function.
Definition at line 37 of file vtkGraphWeightFilter.h.
Member Typedef Documentation
Reimplemented from vtkGraphAlgorithm.
Reimplemented in vtkGraphWeightEuclideanDistanceFilter.
Definition at line 40 of file vtkGraphWeightFilter.h.
Constructor & Destructor Documentation
| vtkGraphWeightFilter::vtkGraphWeightFilter | ( | ) | [inline, protected] |
Definition at line 44 of file vtkGraphWeightFilter.h.
| vtkGraphWeightFilter::~vtkGraphWeightFilter | ( | ) | [inline, protected] |
Definition at line 45 of file vtkGraphWeightFilter.h.
Member Function Documentation
| virtual const char* vtkGraphWeightFilter::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkGraphAlgorithm.
Reimplemented in vtkGraphWeightEuclideanDistanceFilter.
| static int vtkGraphWeightFilter::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 vtkGraphAlgorithm.
Reimplemented in vtkGraphWeightEuclideanDistanceFilter.
| virtual int vtkGraphWeightFilter::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 vtkGraphAlgorithm.
Reimplemented in vtkGraphWeightEuclideanDistanceFilter.
| static vtkGraphWeightFilter* vtkGraphWeightFilter::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkGraphAlgorithm.
Reimplemented in vtkGraphWeightEuclideanDistanceFilter.
| void vtkGraphWeightFilter::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 vtkGraphAlgorithm.
Reimplemented in vtkGraphWeightEuclideanDistanceFilter.
| int vtkGraphWeightFilter::RequestData | ( | vtkInformation * | request, |
| vtkInformationVector ** | inputVector, | ||
| vtkInformationVector * | outputVector | ||
| ) | [protected, virtual] |
This is called by the superclass. This is the method you should override.
Reimplemented from vtkGraphAlgorithm.
| virtual float vtkGraphWeightFilter::ComputeWeight | ( | vtkGraph *const | graph, |
| const vtkEdgeType & | edge | ||
| ) | const [protected, pure virtual] |
Compute the weight on the 'graph' for a particular 'edge'. This is a pure virtual function that must be implemented in subclasses.
Implemented in vtkGraphWeightEuclideanDistanceFilter.
| virtual bool vtkGraphWeightFilter::CheckRequirements | ( | vtkGraph *const | graph | ) | const [protected, virtual] |
Ensure that the 'graph' is has all properties that are needed to compute the weights. For example, in vtkGraphWeightEuclideanDistanceFilter, 'graph' must have Points set for each vertex, as the ComputeWeight function calls GetPoint.
Reimplemented in vtkGraphWeightEuclideanDistanceFilter.
The documentation for this class was generated from the following file:
- dox/Filtering/vtkGraphWeightFilter.h
