vtkCompositeDataCommand Class Reference

#include <vtkCompositeDataCommand.h>

Inheritance diagram for vtkCompositeDataCommand:

[legend]Collaboration diagram for vtkCompositeDataCommand:

[legend]List of all members.

Detailed Description

abstract superclass for commands

vtkCompositeDataCommand and it's subclasses are used by the visitor classes. Visitors apply the command on each item of a collection by calling Execute and passing the appropriate arguments

See also:: vtkCompositeDataVisitor

Created by:

Bertel, Francois

CVS contributions (if > 5%):

Bertel, Francois (100%)

CVS logs (CVSweb):

.cxx (/Filtering/vtkCompositeDataCommand.cxx)
.h (/Filtering/vtkCompositeDataCommand.h)

Definition at line 44 of file vtkCompositeDataCommand.h.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

virtual void Initialize ()

virtual void Execute (vtkCompositeDataVisitor *caller, vtkDataObject *input, void *callData)=0

Static Public Member Functions

int IsTypeOf (const char *type)

vtkCompositeDataCommand * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkCompositeDataCommand ()

virtual ~vtkCompositeDataCommand ()

Member Typedef Documentation

typedef vtkObject vtkCompositeDataCommand::Superclass

Reimplemented from vtkObject.
Reimplemented in vtkApplyFilterCommand, vtkHierarchicalBoxApplyFilterCommand, and vtkMultiBlockApplyFilterCommand.
Definition at line 47 of file vtkCompositeDataCommand.h.

Constructor & Destructor Documentation

vtkCompositeDataCommand::vtkCompositeDataCommand ( ) [protected]

virtual vtkCompositeDataCommand::~vtkCompositeDataCommand ( ) [protected, virtual]

Member Function Documentation

virtual const char* vtkCompositeDataCommand::GetClassName ( ) [virtual]

Reimplemented from vtkObject.
Reimplemented in vtkApplyFilterCommand, vtkHierarchicalBoxApplyFilterCommand, and vtkMultiBlockApplyFilterCommand.

int vtkCompositeDataCommand::IsTypeOf ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkApplyFilterCommand, vtkHierarchicalBoxApplyFilterCommand, and vtkMultiBlockApplyFilterCommand.

virtual int vtkCompositeDataCommand::IsA ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkApplyFilterCommand, vtkHierarchicalBoxApplyFilterCommand, and vtkMultiBlockApplyFilterCommand.

vtkCompositeDataCommand* vtkCompositeDataCommand::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkObject.
Reimplemented in vtkApplyFilterCommand, vtkHierarchicalBoxApplyFilterCommand, and vtkMultiBlockApplyFilterCommand.

void vtkCompositeDataCommand::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 vtkObject.
Reimplemented in vtkApplyFilterCommand, vtkHierarchicalBoxApplyFilterCommand, and vtkMultiBlockApplyFilterCommand.

virtual void vtkCompositeDataCommand::Execute ( vtkCompositeDataVisitor * caller,

vtkDataObject * input,

void * callData

) [pure virtual]

Called by the visitor. The caller should pass itself, the current dataset. The last argument can be used to pass additional information.
Implemented in vtkHierarchicalBoxApplyFilterCommand, and vtkMultiBlockApplyFilterCommand.

virtual void vtkCompositeDataCommand::Initialize ( ) [inline, virtual]

Initialize should be called before iteration starts. It allows the command to initialize things like outputs.
Reimplemented in vtkHierarchicalBoxApplyFilterCommand, and vtkMultiBlockApplyFilterCommand.
Definition at line 61 of file vtkCompositeDataCommand.h.

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

dox/Filtering/vtkCompositeDataCommand.h


Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Initialize ()

virtual void	Execute (vtkCompositeDataVisitor caller, vtkDataObject input, void *callData)=0
Static Public Member Functions
int	IsTypeOf (const char *type)
vtkCompositeDataCommand *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkCompositeDataCommand ()
virtual	~vtkCompositeDataCommand ()