1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
/*=========================================================================
*
* Copyright Insight Software Consortium
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef sitkDualMemberFunctionFactory_h
#define sitkDualMemberFunctionFactory_h
#include "sitkDetail.h"
#include "sitkMemberFunctionFactoryBase.h"
namespace itk
{
namespace simple
{
// this namespace is internal classes not part of the external simple ITK interface
namespace detail
{
/** \class DualMemberFunctionFactory
* \brief A class used to instantiate and generate function objects of
* templated member functions with two template arguments.
*
* \tparam TMemberFunctionPointer is the type of pointer to member
* function
*
* Example member function and pointer:
* \code
* typedef Image::Pointer (Self::*MemberFunctionType)( Image::Pointer );
*
* template<typename TImageType1, TImageType2>
* Image::Pointer ExecuteInternal( Image::Pointer );
* \endcode
*
* 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.
*
* \sa MemberFunctionFactory
*/
template <typename TMemberFunctionPointer>
class DualMemberFunctionFactory
: protected MemberFunctionFactoryBase<TMemberFunctionPointer, std::pair<int, int> >
{
public:
typedef MemberFunctionFactoryBase<TMemberFunctionPointer, std::pair<int, int> > Superclass;
typedef DualMemberFunctionFactory Self;
typedef TMemberFunctionPointer MemberFunctionType;
typedef typename ::detail::FunctionTraits<MemberFunctionType>::ClassType ObjectType;
typedef typename Superclass::FunctionObjectType FunctionObjectType;
/** \brief Constructor which permanently binds the constructed
* object to pObject */
DualMemberFunctionFactory( ObjectType *pObject );
/** \brief Registers a specific member function.
*
* Registers a member function templated over TImageType1 and TImageType2 */
template< typename TImageType1, typename TImageType2 >
void Register( MemberFunctionType pfunc, TImageType1*, TImageType2* );
/** \brief 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:
* \code
* this->m_MemberFactory->RegisterMemberFunctions< PixelIDTypeList1,
* PixelIDTypeList2, 3 > ();
* \endcode
*
* or if a custom addressor is needed:
* \code
* template < class TMemberFunctionPointer >
* struct MyCustomAddressor
* {
* typedef typename ::detail::FunctionTraits<TMemberFunctionPointer>::ClassType ObjectType;
*
* template< typename TImageType1, typename TImageType2 >
* TMemberFunctionPointer operator() ( void ) const
* {
* return &ObjectType::template CustomMethod< TImageType1, TImageType2 >;
* }
* };
*
* this->m_MemberFactory->RegisterMemberFunctions< PixelIDTypeList1,
* PixelIDTypeList2,
* 3,
* MyCustomAddressor<TMFP> > ();
* \endcode
* @{
*/
template < typename TPixelIDTypeList1,
typename TPixelIDTypeList2,
unsigned int VImageDimension,
typename TAddressor >
void RegisterMemberFunctions( void );
template < typename TPixelIDTypeList1,
typename TPixelIDTypeList2,
unsigned int VImageDimension >
void RegisterMemberFunctions( void )
{
typedef detail::DualExecuteInternalAddressor<MemberFunctionType> AddressorType;
this->RegisterMemberFunctions< TPixelIDTypeList1, TPixelIDTypeList2, VImageDimension, AddressorType>();
}
/** @} */
/** \brief Query to determine if an member function has been
* registered for pixelID1, pixelID2 and imageDimension
*/
bool HasMemberFunction( PixelIDValueType pixelID1,
PixelIDValueType pixelID2,
unsigned int imageDimension ) const throw();
/** \brief 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 the value returned by Image::GetDimension()
*
* Example usage:
* \code
* PixelIDValueType pixelID = image->GetPixelIDValue();
* unsigned int dimension = image->GetDimension();
* return this->m_MemberFactory->GetMemberFunction( pixelID, pixelID, dimension )( image );
* \endcode
*
* If the requested member function is not registered then an
* exception is generated. The returned function object is
* guaranteed to be valid.
*/
FunctionObjectType GetMemberFunction( PixelIDValueType pixelID1, PixelIDValueType pixelID2, unsigned int imageDimension );
protected:
ObjectType *m_ObjectPointer;
};
} // end namespace detail
} // end namespace simple
} // end namespace itk
#include "sitkDualMemberFunctionFactory.hxx"
#endif // sitkDualMemberFunctionFactory_h
|
