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 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* 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
*
* https://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.
*
*=========================================================================*/
// Test for interface class constructor override with
// implementation class constructor through object factory methods
#include "itkVersion.h"
#include "itkImage.h"
#include "itkTestingMacros.h"
#include <list>
// Define an interface class with no backend
template <typename TPixel, unsigned int VImageDimension = 2>
class TestImageInterfaceClass : public itk::Image<TPixel, VImageDimension>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(TestImageInterfaceClass);
/** Standard class type aliases. */
using Self = TestImageInterfaceClass;
using Superclass = itk::Image<TPixel, VImageDimension>;
using Pointer = itk::SmartPointer<Self>;
using ConstPointer = itk::SmartPointer<const Self>;
/** Method for creation through the object factory.*/
itkFactoryOnlyNewMacro(TestImageInterfaceClass);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(TestImageInterfaceClass);
// Methods from itkObject
~TestImageInterfaceClass() override = default;
TestImageInterfaceClass() = default;
};
// Define an implementation subclass
template <typename TPixel, unsigned int VImageDimension = 2>
class TestImageImplementationClass : public TestImageInterfaceClass<TPixel, VImageDimension>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(TestImageImplementationClass);
/** Standard class type aliases. */
using Self = TestImageImplementationClass;
using Superclass = TestImageImplementationClass<TPixel, VImageDimension>;
using Pointer = itk::SmartPointer<Self>;
using ConstPointer = itk::SmartPointer<const Self>;
/** Method for creation through the object factory. */
itkFactorylessNewMacro(TestImageImplementationClass);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(TestImageImplementationClass);
// Methods from itkObject
~TestImageImplementationClass() override = default;
TestImageImplementationClass() = default;
};
// Define factory to register implementation override for interface
class TestFactory : public itk::ObjectFactoryBase
{
public:
ITK_DISALLOW_COPY_AND_MOVE(TestFactory);
using Self = TestFactory;
using Superclass = itk::ObjectFactoryBase;
using Pointer = itk::SmartPointer<Self>;
using ConstPointer = itk::SmartPointer<const Self>;
/** Class methods used to interface with the registered factories. */
const char *
GetITKSourceVersion() const override
{
return ITK_SOURCE_VERSION;
}
const char *
GetDescription() const override
{
return "A Test Factory";
}
/** Method for class instantiation. */
itkFactorylessNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(TestFactory);
/** Register one factory of this type */
static void
RegisterOneFactory()
{
auto factory = TestFactory::New();
itk::ObjectFactoryBase::RegisterFactory(factory);
}
private:
TestFactory()
{
this->RegisterOverride(typeid(TestImageInterfaceClass<short, 2>).name(),
typeid(TestImageImplementationClass<short, 2>).name(),
"Test image factory override",
true,
itk::CreateObjectFunction<TestImageImplementationClass<short, 2>>::New());
}
};
using myPointer = itk::Image<short, 2>::Pointer;
bool
TestNewImage(myPointer v, const char * expectedClassName)
{
std::cout << "v->GetNameOfClass(): " << v->GetNameOfClass();
std::cout << ", expectedClassName: " << expectedClassName << std::endl;
if (strcmp(v->GetNameOfClass(), expectedClassName) != 0)
{
std::cout << "Test Failed" << std::endl;
return false;
}
return true;
}
int
itkObjectFactoryOnlyNewTest(int, char *[])
{
// Verify that interface class cannot be instantiated
// if no implementation factory is registered
using PixelType = short;
const size_t Dimension = 2;
using TestImageInterfaceType = TestImageInterfaceClass<PixelType, Dimension>;
ITK_TRY_EXPECT_EXCEPTION(TestImageInterfaceType::New());
// Register implementation override
auto factory = TestFactory::New();
itk::ObjectFactoryBase::RegisterFactory(factory);
// Log all registered factories
std::list<itk::ObjectFactoryBase *> factories = itk::ObjectFactoryBase::GetRegisteredFactories();
std::cout << "----- Registered factories -----" << std::endl;
for (auto & oneFactory : factories)
{
std::cout << " Factory version: " << oneFactory->GetITKSourceVersion() << std::endl
<< " Factory description: " << oneFactory->GetDescription() << std::endl;
std::list<std::string> overrides = oneFactory->GetClassOverrideNames();
std::list<std::string> names = oneFactory->GetClassOverrideWithNames();
std::list<std::string> descriptions = oneFactory->GetClassOverrideDescriptions();
std::list<bool> enableflags = oneFactory->GetEnableFlags();
std::list<std::string>::const_iterator n = names.begin();
std::list<std::string>::const_iterator d = descriptions.begin();
std::list<bool>::const_iterator e = enableflags.begin();
for (std::list<std::string>::const_iterator o = overrides.begin(); o != overrides.end(); ++o, ++n, ++d, ++e)
{
std::cout << " Override " << *o << " with " << *n << std::endl
<< " described as \"" << *d << '"' << std::endl
<< " enabled " << *e << std::endl;
}
}
std::cout << "----- -----" << std::endl;
TestImageInterfaceType::Pointer v;
ITK_TRY_EXPECT_NO_EXCEPTION(v = TestImageInterfaceType::New());
factory->Print(std::cout);
if (!TestNewImage(v, "TestImageImplementationClass"))
{
return EXIT_FAILURE;
}
// disable interface class creation through the factory
factory->Disable(typeid(TestImageInterfaceType).name());
ITK_TRY_EXPECT_EXCEPTION(v = TestImageInterfaceType::New());
// re-enable interface class creation through the factory
using TestImageImplementationType = TestImageImplementationClass<PixelType, Dimension>;
factory->SetEnableFlag(true, typeid(TestImageInterfaceType).name(), typeid(TestImageImplementationType).name());
ITK_TRY_EXPECT_NO_EXCEPTION(v = TestImageInterfaceType::New());
if (!TestNewImage(v, "TestImageImplementationClass"))
{
return EXIT_FAILURE;
}
// remove factory and verify interface class cannot be created
itk::ObjectFactoryBase::UnRegisterFactory(factory);
ITK_TRY_EXPECT_EXCEPTION(v = TestImageInterfaceType::New());
return EXIT_SUCCESS;
}
|