SimpleITK  2.0.0rc2.post59
Public Types | Public Member Functions | Protected Attributes | List of all members
itk::simple::detail::DualMemberFunctionFactory< TMemberFunctionPointer > Class Template Reference

A class used to instantiate and generate function objects of templated member functions with two template arguments. More...

#include <sitkDualMemberFunctionFactory.h>

+ Inheritance diagram for itk::simple::detail::DualMemberFunctionFactory< TMemberFunctionPointer >:
+ Collaboration diagram for itk::simple::detail::DualMemberFunctionFactory< TMemberFunctionPointer >:

Public Types

using FunctionObjectType = typename Superclass::FunctionObjectType
 
using MemberFunctionType = TMemberFunctionPointer
 
using ObjectType = typename ::detail::FunctionTraits< MemberFunctionType >::ClassType
 
using Self = DualMemberFunctionFactory
 
using Superclass = MemberFunctionFactoryBase< TMemberFunctionPointer, std::tuple< unsigned int, int, unsigned int, int > >
 

Public Member Functions

 DualMemberFunctionFactory (ObjectType *pObject)
 Constructor which permanently binds the constructed object to pObject. More...
 
FunctionObjectType GetMemberFunction (PixelIDValueType pixelID1, PixelIDValueType pixelID2, unsigned int imageDimension)
 Returns a function object for the combination of PixelID1 and PixelID2, and image dimension. More...
 
bool HasMemberFunction (PixelIDValueType pixelID1, PixelIDValueType pixelID2, unsigned int imageDimension) const noexcept
 Query to determine if an member function has been registered for pixelID1, pixelID2 and imageDimension. More...
 
template<typename TImageType1 , typename TImageType2 >
void Register (MemberFunctionType pfunc, TImageType1 *, TImageType2 *)
 Registers a specific member function. More...
 
template<typename TPixelIDTypeList1 , typename TPixelIDTypeList2 , unsigned int VImageDimension, typename TAddressor >
void RegisterMemberFunctions ()
 Registers the member functions for all combinations of TPixelIDTypeList1 and PixelIDTypeList2. More...
 
template<typename TPixelIDTypeList1 , typename TPixelIDTypeList2 , unsigned int VImageDimension>
void RegisterMemberFunctions ()
 Registers the member functions for all combinations of TPixelIDTypeList1 and PixelIDTypeList2. More...
 

Protected Attributes

ObjectTypem_ObjectPointer
 

Detailed Description

template<typename TMemberFunctionPointer>
class itk::simple::detail::DualMemberFunctionFactory< TMemberFunctionPointer >

A class used to instantiate and generate function objects of templated member functions with two template arguments.

Template Parameters
TMemberFunctionPointeris the type of pointer to member function

Example member function and pointer:

template<typename TImageType1, TImageType2>
Image::Pointer ExecuteInternal( Image::Pointer );

The provided Addressor will instantiate the templeted member functions by taking the address in the RegisterMethods. Later they can be retrieve with the GetMemberFunction method, which returns a function object with the same arguments as the templated member function pointer.

An instance of a MemberFunctionFactory is bound to a specific instance of an object, so that the returned function object does not need to have the calling object specified.

Warning
Use this class with caution because it can instantiate a combinatorial number of methods.
See also
MemberFunctionFactory

Definition at line 65 of file sitkDualMemberFunctionFactory.h.

Member Typedef Documentation

◆ FunctionObjectType

template<typename TMemberFunctionPointer >
using itk::simple::detail::DualMemberFunctionFactory< TMemberFunctionPointer >::FunctionObjectType = typename Superclass::FunctionObjectType

Definition at line 76 of file sitkDualMemberFunctionFactory.h.

◆ MemberFunctionType

template<typename TMemberFunctionPointer >
using itk::simple::detail::DualMemberFunctionFactory< TMemberFunctionPointer >::MemberFunctionType = TMemberFunctionPointer

Definition at line 74 of file sitkDualMemberFunctionFactory.h.

◆ ObjectType

template<typename TMemberFunctionPointer >
using itk::simple::detail::DualMemberFunctionFactory< TMemberFunctionPointer >::ObjectType = typename ::detail::FunctionTraits<MemberFunctionType>::ClassType

Definition at line 75 of file sitkDualMemberFunctionFactory.h.

◆ Self

template<typename TMemberFunctionPointer >
using itk::simple::detail::DualMemberFunctionFactory< TMemberFunctionPointer >::Self = DualMemberFunctionFactory

Definition at line 72 of file sitkDualMemberFunctionFactory.h.

◆ Superclass

template<typename TMemberFunctionPointer >
using itk::simple::detail::DualMemberFunctionFactory< TMemberFunctionPointer >::Superclass = MemberFunctionFactoryBase<TMemberFunctionPointer, std::tuple<unsigned int, int, unsigned int, int> >

Definition at line 71 of file sitkDualMemberFunctionFactory.h.

Constructor & Destructor Documentation

◆ DualMemberFunctionFactory()

template<typename TMemberFunctionPointer >
itk::simple::detail::DualMemberFunctionFactory< TMemberFunctionPointer >::DualMemberFunctionFactory ( ObjectType pObject)

Constructor which permanently binds the constructed object to pObject.

Member Function Documentation

◆ GetMemberFunction()

template<typename TMemberFunctionPointer >
FunctionObjectType itk::simple::detail::DualMemberFunctionFactory< TMemberFunctionPointer >::GetMemberFunction ( PixelIDValueType  pixelID1,
PixelIDValueType  pixelID2,
unsigned int  imageDimension 
)

Returns a function object for the combination of PixelID1 and PixelID2, and image dimension.

pixelID1 or pixelID2 is the value of Image::GetPixelIDValue(), or PixelIDToPixelIDValue<PixelIDType>::Result

imageDimension is the value returned by Image::GetDimension()

Example usage:

PixelIDValueType pixelID = image->GetPixelIDValue();
unsigned int dimension = image->GetDimension();
return this->m_MemberFactory->GetMemberFunction( pixelID, pixelID, dimension )( image );

If the requested member function is not registered then an exception is generated. The returned function object is guaranteed to be valid.

◆ HasMemberFunction()

template<typename TMemberFunctionPointer >
bool itk::simple::detail::DualMemberFunctionFactory< TMemberFunctionPointer >::HasMemberFunction ( PixelIDValueType  pixelID1,
PixelIDValueType  pixelID2,
unsigned int  imageDimension 
) const
noexcept

Query to determine if an member function has been registered for pixelID1, pixelID2 and imageDimension.

◆ Register()

template<typename TMemberFunctionPointer >
template<typename TImageType1 , typename TImageType2 >
void itk::simple::detail::DualMemberFunctionFactory< TMemberFunctionPointer >::Register ( MemberFunctionType  pfunc,
TImageType1 *  ,
TImageType2 *   
)

Registers a specific member function.

Registers a member function templated over TImageType1 and TImageType2

◆ RegisterMemberFunctions() [1/2]

template<typename TMemberFunctionPointer >
template<typename TPixelIDTypeList1 , typename TPixelIDTypeList2 , unsigned int VImageDimension, typename TAddressor >
void itk::simple::detail::DualMemberFunctionFactory< TMemberFunctionPointer >::RegisterMemberFunctions ( )

Registers the member functions for all combinations of TPixelIDTypeList1 and PixelIDTypeList2.

With out the third template argument, the DualExecuteInternalAddressor will be used to instantiate "DualExecuteInternal" methods over the two image types referenced by all combination of type in the first list with types in the second.

The optional third template parameter provides a custom addressor.

Example usage:

this->m_MemberFactory->RegisterMemberFunctions< PixelIDTypeList1,
PixelIDTypeList2, 3 > ();

or if a custom addressor is needed:

template < class TMemberFunctionPointer >
struct MyCustomAddressor
{
using ObjectType = typename ::detail::FunctionTraits<TMemberFunctionPointer>::ClassType;
template< typename TImageType1, typename TImageType2 >
TMemberFunctionPointer operator() ( void ) const
{
return &ObjectType::template CustomMethod< TImageType1, TImageType2 >;
}
};
this->m_MemberFactory->RegisterMemberFunctions< PixelIDTypeList1,
PixelIDTypeList2,
3,
MyCustomAddressor<TMFP> > ();

◆ RegisterMemberFunctions() [2/2]

template<typename TMemberFunctionPointer >
template<typename TPixelIDTypeList1 , typename TPixelIDTypeList2 , unsigned int VImageDimension>
void itk::simple::detail::DualMemberFunctionFactory< TMemberFunctionPointer >::RegisterMemberFunctions ( )
inline

Registers the member functions for all combinations of TPixelIDTypeList1 and PixelIDTypeList2.

With out the third template argument, the DualExecuteInternalAddressor will be used to instantiate "DualExecuteInternal" methods over the two image types referenced by all combination of type in the first list with types in the second.

The optional third template parameter provides a custom addressor.

Example usage:

this->m_MemberFactory->RegisterMemberFunctions< PixelIDTypeList1,
PixelIDTypeList2, 3 > ();

or if a custom addressor is needed:

template < class TMemberFunctionPointer >
struct MyCustomAddressor
{
using ObjectType = typename ::detail::FunctionTraits<TMemberFunctionPointer>::ClassType;
template< typename TImageType1, typename TImageType2 >
TMemberFunctionPointer operator() ( void ) const
{
return &ObjectType::template CustomMethod< TImageType1, TImageType2 >;
}
};
this->m_MemberFactory->RegisterMemberFunctions< PixelIDTypeList1,
PixelIDTypeList2,
3,
MyCustomAddressor<TMFP> > ();

Definition at line 133 of file sitkDualMemberFunctionFactory.h.

Member Data Documentation

◆ m_ObjectPointer

template<typename TMemberFunctionPointer >
ObjectType* itk::simple::detail::DualMemberFunctionFactory< TMemberFunctionPointer >::m_ObjectPointer
protected

Definition at line 171 of file sitkDualMemberFunctionFactory.h.


The documentation for this class was generated from the following file:
itk::Image::Pointer
SmartPointer< Self > Pointer
itk::simple::detail::DualMemberFunctionFactory::ObjectType
typename ::detail::FunctionTraits< MemberFunctionType >::ClassType ObjectType
Definition: sitkDualMemberFunctionFactory.h:75
itk::simple::detail::DualMemberFunctionFactory::Self
DualMemberFunctionFactory Self
Definition: sitkDualMemberFunctionFactory.h:72
itk::simple::detail::DualMemberFunctionFactory::MemberFunctionType
TMemberFunctionPointer MemberFunctionType
Definition: sitkDualMemberFunctionFactory.h:74
itk::simple::PixelIDValueType
int PixelIDValueType
Definition: sitkPixelIDValues.h:32