Mantid
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Friends | List of all members
Mantid::API::TransformScaleFactoryImpl Class Reference

Constructs a scaling transform object from a string. More...

#include <TransformScaleFactory.h>

Inheritance diagram for Mantid::API::TransformScaleFactoryImpl:
Mantid::Kernel::DynamicFactory< ITransformScale >

Public Member Functions

std::shared_ptr< ITransformScalecreate (const std::string &type) const override
 Returns scaling transform. More...
 
TransformScaleFactoryImploperator= (const TransformScaleFactoryImpl &)=delete
 
 TransformScaleFactoryImpl (const TransformScaleFactoryImpl &)=delete
 
- Public Member Functions inherited from Mantid::Kernel::DynamicFactory< ITransformScale >
virtual std::shared_ptr< ITransformScalecreate (const std::string &className) const
 Creates a new instance of the class with the given name. More...
 
virtual ITransformScalecreateUnwrapped (const std::string &className) const
 Creates a new instance of the class with the given name, which is not wrapped in a boost shared_ptr. More...
 
void disableNotifications ()
 Disable notifications. More...
 
 DynamicFactory (const DynamicFactory &)=delete
 
void enableNotifications ()
 Enable notifications. More...
 
bool exists (const std::string &className) const
 Returns true if the given class is currently registered. More...
 
virtual const std::vector< std::string > getKeys () const
 Returns the keys in the map. More...
 
DynamicFactoryoperator= (const DynamicFactory &)=delete
 
void subscribe (const std::string &className)
 Registers the instantiator for the given class with the DynamicFactory. More...
 
void subscribe (const std::string &className, std::unique_ptr< AbstractFactory > pAbstractFactory, SubscribeAction replace=ErrorIfExists)
 Registers the instantiator for the given class with the DynamicFactory. More...
 
void unsubscribe (const std::string &className)
 Unregisters the given class and deletes the instantiator for the class. More...
 
virtual ~DynamicFactory ()=default
 Destroys the DynamicFactory and deletes the instantiators for all registered classes. More...
 

Private Member Functions

ITransformScalecreateUnwrapped (const std::string &className) const override
 Override the DynamicFactory::createUnwrapped() method. More...
 
 TransformScaleFactoryImpl ()=default
 Private Constructor for singleton class. More...
 
 ~TransformScaleFactoryImpl () override=default
 

Friends

struct Mantid::Kernel::CreateUsingNew< TransformScaleFactoryImpl >
 

Additional Inherited Members

- Public Types inherited from Mantid::Kernel::DynamicFactory< ITransformScale >
using AbstractFactory = AbstractInstantiator< ITransformScale >
 A typedef for the instantiator. More...
 
enum  NotificationStatus
 Defines the whether notifications are dispatched. More...
 
enum  SubscribeAction
 Defines replacement behaviour. More...
 
- Public Attributes inherited from Mantid::Kernel::DynamicFactory< ITransformScale >
Poco::NotificationCenter notificationCenter
 Sends notifications to observers. More...
 
- Protected Member Functions inherited from Mantid::Kernel::DynamicFactory< ITransformScale >
 DynamicFactory ()
 Protected constructor for base class. More...
 

Detailed Description

Constructs a scaling transform object from a string.

Definition at line 30 of file TransformScaleFactory.h.

Constructor & Destructor Documentation

◆ TransformScaleFactoryImpl() [1/2]

Mantid::API::TransformScaleFactoryImpl::TransformScaleFactoryImpl ( const TransformScaleFactoryImpl )
delete

◆ TransformScaleFactoryImpl() [2/2]

Mantid::API::TransformScaleFactoryImpl::TransformScaleFactoryImpl ( )
privatedefault

Private Constructor for singleton class.

◆ ~TransformScaleFactoryImpl()

Mantid::API::TransformScaleFactoryImpl::~TransformScaleFactoryImpl ( )
overrideprivatedefault

Member Function Documentation

◆ create()

ITransformScale_sptr Mantid::API::TransformScaleFactoryImpl::create ( const std::string &  type) const
overridevirtual

Returns scaling transform.

Creates an instance of the appropriate scaling transform.

Parameters
typeThe name of the scaling transform
Returns
A shared pointer to the created ITransformScale implementation
Exceptions
Exception::NotFoundErrorIf the requested transform is not registered

Reimplemented from Mantid::Kernel::DynamicFactory< ITransformScale >.

Definition at line 23 of file TransformScaleFactory.cpp.

References Mantid::Kernel::DynamicFactory< Base, Comparator >::create(), Mantid::Kernel::Logger::error(), and Mantid::API::g_log.

◆ createUnwrapped()

ITransformScale * Mantid::API::TransformScaleFactoryImpl::createUnwrapped ( const std::string &  className) const
overrideprivatevirtual

Override the DynamicFactory::createUnwrapped() method.

We don't want it used here.

We don't want it used here. Making it private will prevent most accidental usage, though of course this could be called through a DynamicFactory pointer or reference.

Parameters
classNameArgument that's ignored
Returns
Never
Exceptions
Exception::NotImplementedErrorevery time!

Reimplemented from Mantid::Kernel::DynamicFactory< ITransformScale >.

Definition at line 42 of file TransformScaleFactory.cpp.

References UNUSED_ARG.

◆ operator=()

TransformScaleFactoryImpl & Mantid::API::TransformScaleFactoryImpl::operator= ( const TransformScaleFactoryImpl )
delete

Friends And Related Function Documentation

◆ Mantid::Kernel::CreateUsingNew< TransformScaleFactoryImpl >

Definition at line 35 of file TransformScaleFactory.h.


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