vtkDoubleDispatcher< BaseLhs, BaseRhs, ReturnType, CastingPolicy > Class Template Reference

Dispatch to functor based on two pointer types. More...

#include <vtkDoubleDispatcher.h>

Public Member Functions
template<class SomeLhs , class SomeRhs , class Functor >
void	Add (Functor fun)
	Add in a functor that is mapped to the combination of the two template parameters passed in. More...
template<class SomeLhs , class SomeRhs >
bool	Remove ()
	Remove a functor that is bound to the given parameter types. More...
ReturnType	Go (BaseLhs *lhs, BaseRhs *rhs)
	Given two pointers of objects that derive from the BaseLhs and BaseRhs we find the matching functor that was added, and call it passing along the given parameters. More...

Protected Types
typedef vtkDispatcherCommon::TypeInfo	TypeInfo
typedef vtkDoubleDispatcherPrivate::Functor< ReturnType, BaseLhs, BaseRhs >	MappedType
typedef std::pair< TypeInfo, TypeInfo >	KeyType
typedef std::map< KeyType, MappedType >	MapType

Protected Member Functions
void	DoAddFunctor (TypeInfo lhs, TypeInfo rhs, MappedType fun)
bool	DoRemove (TypeInfo lhs, TypeInfo rhs)

Protected Attributes
MapType	FunctorMap

Detailed Description

template<class BaseLhs, class BaseRhs = BaseLhs, typename ReturnType = void, template< class, class > class CastingPolicy = vtkDispatcherCommon::vtkCaster>
class vtkDoubleDispatcher< BaseLhs, BaseRhs, ReturnType, CastingPolicy >

Dispatch to functor based on two pointer types.

vtkDoubleDispatcher is a class that allows calling a functor based on the derived types of two pointers. This form of dynamic dispatching allows the conversion of runtime polymorphism to a compile time polymorphism. For example it can be used as a replacement for the vtkTemplateMacro when you want to know multiple parameter types, or need to call a specialized implementation for a subset

Note: By default the return type is void.

The functors that are passed around can contain state, and are allowed to be const or non const. If you are using a functor that does have state, make sure your copy constructor is correct.

struct functor{
  template<typename T,typename U>
  void operator()(T& t,U& u) const
  {

  }
};

Here is an example of using the double dispatcher.
 \code
 vtkDoubleDispatcher<vtkObject,vtkObject,vtkPoints*> dispatcher;
 dispatcher.Add<vtkPoints,vtkDoubleArray>(makePointsWrapperFunctor());
 dispatcher.Add<vtkPoints,vtkPoints>(straightCopyFunctor());
 dispatcher.Go(ptr1,ptr2); //this will return a vtkPoints pointer

See also

vtkDispatcher

Tests:

vtkDoubleDispatcher (Tests)

Definition at line 86 of file vtkDoubleDispatcher.h.

Member Typedef Documentation

template<class BaseLhs , class BaseRhs = BaseLhs, typename ReturnType = void, template< class, class > class CastingPolicy = vtkDispatcherCommon::vtkCaster>

typedef vtkDispatcherCommon::TypeInfo vtkDoubleDispatcher< BaseLhs, BaseRhs, ReturnType, CastingPolicy >::TypeInfo

protected

Definition at line 133 of file vtkDoubleDispatcher.h.

template<class BaseLhs , class BaseRhs = BaseLhs, typename ReturnType = void, template< class, class > class CastingPolicy = vtkDispatcherCommon::vtkCaster>

typedef vtkDoubleDispatcherPrivate::Functor<ReturnType,BaseLhs,BaseRhs> vtkDoubleDispatcher< BaseLhs, BaseRhs, ReturnType, CastingPolicy >::MappedType

protected

Definition at line 135 of file vtkDoubleDispatcher.h.

template<class BaseLhs , class BaseRhs = BaseLhs, typename ReturnType = void, template< class, class > class CastingPolicy = vtkDispatcherCommon::vtkCaster>

typedef std::pair<TypeInfo,TypeInfo> vtkDoubleDispatcher< BaseLhs, BaseRhs, ReturnType, CastingPolicy >::KeyType

protected

Definition at line 140 of file vtkDoubleDispatcher.h.

template<class BaseLhs , class BaseRhs = BaseLhs, typename ReturnType = void, template< class, class > class CastingPolicy = vtkDispatcherCommon::vtkCaster>

typedef std::map<KeyType, MappedType > vtkDoubleDispatcher< BaseLhs, BaseRhs, ReturnType, CastingPolicy >::MapType

protected

Definition at line 141 of file vtkDoubleDispatcher.h.

Member Function Documentation

template<class BaseLhs , class BaseRhs = BaseLhs, typename ReturnType = void, template< class, class > class CastingPolicy = vtkDispatcherCommon::vtkCaster>

template<class SomeLhs , class SomeRhs , class Functor >

void vtkDoubleDispatcher< BaseLhs, BaseRhs, ReturnType, CastingPolicy >::Add ( Functor  fun )

inline

Add in a functor that is mapped to the combination of the two template parameters passed in.

When instances of the two parameters are passed in on the Go method we will call the functor and pass along the given parameters. Note: This copies the functor so pass stateful functors by pointer.

vtkDoubleDispatcher<vtkDataModel,vtkCell> dispatcher;
dispatcher.Add<vtkImageData,vtkVoxel>(exampleFunctor());
dispatcher.Add<vtkImageData,vtkVoxel>(&exampleFunctorWithState);

Definition at line 103 of file vtkDoubleDispatcher.h.

template<class BaseLhs, class BaseRhs = BaseLhs, typename ReturnType = void, template< class, class > class CastingPolicy = vtkDispatcherCommon::vtkCaster>

template<class SomeLhs , class SomeRhs >

bool vtkDoubleDispatcher< BaseLhs, BaseRhs, ReturnType, CastingPolicy >::Remove ( )

inline

Remove a functor that is bound to the given parameter types.

Will return true if we did remove a functor.

Definition at line 110 of file vtkDoubleDispatcher.h.

template<class BaseLhs , class BaseRhs , typename ReturnType , template< class, class > class CastingPolicy>

ReturnType vtkDoubleDispatcher< BaseLhs, BaseRhs, ReturnType, CastingPolicy >::Go	(	BaseLhs *	lhs,
		BaseRhs *	rhs
	)

Given two pointers of objects that derive from the BaseLhs and BaseRhs we find the matching functor that was added, and call it passing along the given parameters.

It should be noted that the functor will be called with the parameters being the derived type that Functor was registered with.

Note: This will only find exact matches. So if you add functor to find vtkDataArray,vtkDataArray, it will not be called if passed with vtkDoubleArray,vtkDoubleArray.

vtkDoubleDispatcher<vtkDataArray,vtkDataArray> dispatcher;
dispatcher.Add(vtkFloatArray,vtkFloatArray>(floatFunctor())
dispatcher.Add(vtkFloatArray,vtkDoubleArray>(mixedTypeFunctor())
dispatcher.Go( dataArray1, dataArray2);

Definition at line 211 of file vtkDoubleDispatcher.h.

template<class BaseLhs , class BaseRhs , typename ReturnType , template< class, class > class CastingPolicy>

void vtkDoubleDispatcher< BaseLhs, BaseRhs, ReturnType, CastingPolicy >::DoAddFunctor ( TypeInfo  lhs, TypeInfo  rhs, MappedType  fun  )

protected

Definition at line 193 of file vtkDoubleDispatcher.h.

template<class BaseLhs , class BaseRhs , typename ReturnType , template< class, class > class CastingPolicy>

bool vtkDoubleDispatcher< BaseLhs, BaseRhs, ReturnType, CastingPolicy >::DoRemove ( TypeInfo  lhs, TypeInfo  rhs  )

protected

Definition at line 202 of file vtkDoubleDispatcher.h.

Member Data Documentation

template<class BaseLhs, class BaseRhs = BaseLhs, typename ReturnType = void, template< class, class > class CastingPolicy = vtkDispatcherCommon::vtkCaster>

MapType vtkDoubleDispatcher< BaseLhs, BaseRhs, ReturnType, CastingPolicy >::FunctorMap

protected

Definition at line 142 of file vtkDoubleDispatcher.h.

---

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

• /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Common/DataModel/vtkDoubleDispatcher.h