Main Page Groups Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Concepts

itk::fem::VisitorDispatcher< TVisitedClass, TVisitorBase, TVisitFunctionPointerType > Class Template Reference

This class provides the functionality needed to apply the correct visitor function to object of some class. The specific visitor function is choosen, based on a given pointer to some object. More...

#include <itkVisitorDispatcher.h>

Collaboration diagram for itk::fem::VisitorDispatcher< TVisitedClass, TVisitorBase, TVisitFunctionPointerType >:

[legend]List of all members.


[NOHEADER]
VisitFunctionPointerType	Visit (VisitorBasePointer l)
Public Types
typedef TVisitedClass	VisitedClass
typedef TVisitorBase	VisitorBase
typedef VisitedClass::Pointer	VisitedClassPointer
typedef VisitedClass::ConstPointer	VisitedClassConstPointer
typedef VisitorBase::Pointer	VisitorBasePointer
typedef TVisitFunctionPointerType	VisitFunctionPointerType
typedef int	ClassIDType
typedef std::map< ClassIDType, VisitFunctionPointerType >	VisitorsArrayType
typedef VisitorsArrayType::value_type	VisitorsArray_value_type
Static Public Member Functions

template<class TVisitorClass> bool	RegisterVisitor (TVisitorClass *, VisitFunctionPointerType visitor_function)

Detailed Description

template<class TVisitedClass, class TVisitorBase, class TVisitFunctionPointerType = typename VisitorDispatcherTemplateHelper<TVisitedClass, TVisitorBase>::FunctionPointerType>
class itk::fem::VisitorDispatcher< TVisitedClass, TVisitorBase, TVisitFunctionPointerType >

This class provides the functionality needed to apply the correct visitor function to object of some class. The specific visitor function is choosen, based on a given pointer to some object.

A visitor function is a function, that can perform various operations on objects of various classes. Usually we want this operation applied on any of the polymorphic derived classes. The specific operation is defined in visitor functions.

For example: calculating the area of Shape objects. In this case the function that calculates the area of a specific shape, is called the visitor function. A specific version of this function must be defined for each class, on which you want the perform the operation (Area(Circle*); Area(Square*); ...).

Now suppose that you want different operations performed on the shape objects. Which operation will be performed is specified by the class of the Visitor object. If the Visitor object is of class Area, then the area of objects will be calculated. If the visitor is object of class Circumference, then the circumference of the shapes will be calculated...

In order to be able to do that and provide the framework to easily add new Visitor as well as Visited classes, we create the VisitorDispatcher class. It is implemented as a singelton. It stores pointers to Visitor functions together with the information about which Visitor function must be called in order to perform an operation specified by Visitor class on objects of Visited class.

To make a specific base class and all its derived classes visitable, you must make the following changes to your code:

1. Declare the folowing virtual member function in the base class:

class BaseVisitable { ... virtual ReturnType AcceptVisitor( VisitorBase* ) = 0; ... };

2. Implement this function in ALL derived classes like this:

class MyVisitableClass : public BaseVisitable { ... virtual ReturnType AcceptVisitor( VisitorBase* l ) { return VisitorDispatcher<MyVisitableClass,VisitorBase,VisitFunctionPointerType>::Visit( <parameters> ); } ... };

Since this code is the same for all derived element classes, you should probably put it in the macro.

3. Register each visitor class with the VisitorDispatcher class before it is called. This is done by calling the member function RegisterVisitor of the VisitorDispatcher class and providing the pointer to the Visitor function that performs the required task. The visitor function must be declared according to the VisitFunctionPointerType template parameter.

ReturnType MyVisitor_Function( ... );

Once all this is done, you can perform various operations on objects of all derived classes by simply calling the Visit function on the pointer to base class and providing a pointer to the specific Visitor object:

object->AcceptVisitor(visitor);

The Visitor class is templated over several classes that make its use generic and simple.

TVisitedClass Class of objects that will be visited.

TVisitorBase Base class of Visitor objects. Objects of class TVisitedClass will be visited by object of any registered class that is derived from TVisitorBase.

TVisitFunctionPointerType Type of visit functions. Visitor dispatcher stores an array of pointers to these functions. Default function pointer type is provided.

Note:: Template parameter TVisitFunctionPointerType in general doesn't have to be a pointer to function. In fact, it can be any type Object of this type will be returned, when calling the VisitorDispatcher::Visit function.

Definition at line 134 of file itkVisitorDispatcher.h.

Member Typedef Documentation

Member Function Documentation

template<class TVisitedClass, class TVisitorBase, class TVisitFunctionPointerType = typename VisitorDispatcherTemplateHelper<TVisitedClass, TVisitorBase>::FunctionPointerType>

template<class TVisitorClass>

bool itk::fem::VisitorDispatcher< TVisitedClass, TVisitorBase, TVisitFunctionPointerType >::RegisterVisitor ( TVisitorClass * ,

VisitFunctionPointerType visitor_function

) [inline, static]

Adds function visitor_function to the VisitorDispatcher class and associates this function with the class TVisitorClass. This means that when member function Visit(e,l) is called, the fucntion visitor_function will be called, if object pointed to by l is of class TVisitorClass.
To automatically register visitor on library initialization, you would call this function immediatly after defining an implementation function class.
Visitor class must define a static member function "int CLID()" that returns the class ID and a virtual member int ClassID() that does the same.
bool Dummy = VisitorDispatcher<Bar,Load>::RegisterVisitor((LoadGrav*)0, &LoadGravImpl);

Parameters:

visitor_function Pointer to a visitor function.

Note:
Dummy class pointer must be passed as a first parameter to automatically deduct the correct template parameter TVisitorClass. Technically we would like to call the this function as VisitorDispatcher<...>::RegisterVisitor<MyVisitorClass>(...), but MS C compiler crashes if we do this. This is a work around. You should pass null pointer casted to the TVisitorClass when calling this function.

See also:
Visit

Definition at line 209 of file itkVisitorDispatcher.h.
References itk::SimpleFastMutexLock::Lock(), itk::fem::VisitorDispatcher< TVisitedClass, TVisitorBase, TVisitFunctionPointerType >::m_MutexLock, itk::fem::VisitorDispatcher< TVisitedClass, TVisitorBase, TVisitFunctionPointerType >::VisitedClass, itk::fem::VisitorDispatcher< TVisitedClass, TVisitorBase, TVisitFunctionPointerType >::visitors, and itk::fem::VisitorDispatcher< TVisitedClass, TVisitorBase, TVisitFunctionPointerType >::VisitorsArray_value_type.

template<class TVisitedClass, class TVisitorBase, class TVisitFunctionPointerType>

VisitorDispatcher< TVisitedClass, TVisitorBase, TVisitFunctionPointerType >::VisitFunctionPointerType itk::fem::VisitorDispatcher< TVisitedClass, TVisitorBase, TVisitFunctionPointerType >::Visit ( VisitorBasePointer l ) [static]

Returns the pointer to the correct implementation of the visit function. based on the class of object passed in l.
Before this function can be called, the visitor functions must be added to the VisitorDispatcher class for visitor class that is derived from TVisitorBase.

Parameters:

l Pointer to an object. Class of this object determines which pointer to visit function will be returned.

See also:
RegisterVisitor

Definition at line 309 of file itkVisitorDispatcher.h.
References itk::fem::VisitorDispatcher< TVisitedClass, TVisitorBase, TVisitFunctionPointerType >::VisitedClass.

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

itkVisitorDispatcher.h

Generated at Thu May 25 03:02:05 2006 for ITK by

itk::fem::VisitorDispatcher< TVisitedClass, TVisitorBase, TVisitFunctionPointerType > Class Template Reference

[NOHEADER]

Public Types

Static Public Member Functions

Detailed Description

template<class TVisitedClass, class TVisitorBase, class TVisitFunctionPointerType = typename VisitorDispatcherTemplateHelper<TVisitedClass, TVisitorBase>::FunctionPointerType> class itk::fem::VisitorDispatcher< TVisitedClass, TVisitorBase, TVisitFunctionPointerType >

Member Typedef Documentation

Member Function Documentation

template<class TVisitedClass, class TVisitorBase, class TVisitFunctionPointerType = typename VisitorDispatcherTemplateHelper<TVisitedClass, TVisitorBase>::FunctionPointerType>
class itk::fem::VisitorDispatcher< TVisitedClass, TVisitorBase, TVisitFunctionPointerType >