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
|
/*=========================================================================
*
* Copyright UMC Utrecht and contributors
*
* 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 elxInstallFunctions_h
#define elxInstallFunctions_h
#include "elxComponentDatabase.h"
namespace elastix
{
/**
* \class InstallFunctions
*
* \brief A class with functions that are used to install elastix components
*
* In elastix the metric/transform/dimension/pixeltype etc. are all selected
* at runtime. To make this possible, all components (metric/transform etc)
* have to compiled for different dimension/pixeltype. The elx::ComponentDatabase
* stores for each instance and each pixeltype/dimension a pointers to a function
* that creates a component of the specific type. The InstallFunctions
* class provides functions that aid in filling the elx::ComponentDatabase.
* The functions are called when elastix is started. Do not do this
* directly. Use the elxInstallMacro instead (see elxMacro.h).
*
* \sa ComponentDatabase
* \ingroup Install
*/
template <class TAnyItkObject>
class ITK_TEMPLATE_EXPORT InstallFunctions
{
public:
/** Standard.*/
using Self = InstallFunctions;
using AnyItkObjectType = TAnyItkObject;
/** The baseclass of all objects that are returned by the Creator. */
using ObjectPointer = ComponentDatabase::ObjectPointer;
/** The type of the index in the component database.
* Each combination of pixeltype/dimension corresponds
* a specific number, the index (unsigned int). */
using IndexType = ComponentDatabase::IndexType;
/** The type of the key in the component database (=string) */
using ComponentDescriptionType = ComponentDatabase::ComponentDescriptionType;
/** A wrap around the New() functions of itkObjects. */
static ObjectPointer
Creator()
{
return AnyItkObjectType::New().GetPointer();
}
/** This function places the address of the New() function
* of AnyItkObjectType in the ComponentDatabase. Returns 0 in
* case of no errors. */
static int
InstallComponent(const ComponentDescriptionType & name, IndexType i, ComponentDatabase * cdb)
{
return cdb->SetCreator(name, i, Self::Creator);
}
};
} // end namespace elastix
#endif // end #ifndef elxInstallFunctions_h
|