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

The CostFunctionFactory class is in charge of the creation of concrete instances of minimizers. More...

#include <CostFunctionFactory.h>

Inheritance diagram for Mantid::API::CostFunctionFactoryImpl:
Mantid::Kernel::DynamicFactory< ICostFunction >

Public Member Functions

ICostFunctioncreateFunction (const std::string &type) const
 Creates an instance of a cost function. More...
 
- Public Member Functions inherited from Mantid::Kernel::DynamicFactory< ICostFunction >
virtual std::shared_ptr< ICostFunctioncreate (const std::string &className) const
 Creates a new instance of the class with the given name. More...
 
virtual ICostFunctioncreateUnwrapped (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

 CostFunctionFactoryImpl ()
 Private Constructor for singleton class. More...
 

Friends

struct Mantid::Kernel::CreateUsingNew< CostFunctionFactoryImpl >
 

Additional Inherited Members

- Public Types inherited from Mantid::Kernel::DynamicFactory< ICostFunction >
using AbstractFactory = AbstractInstantiator< ICostFunction >
 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< ICostFunction >
Poco::NotificationCenter notificationCenter
 Sends notifications to observers. More...
 
- Protected Member Functions inherited from Mantid::Kernel::DynamicFactory< ICostFunction >
 DynamicFactory ()
 Protected constructor for base class. More...
 

Detailed Description

The CostFunctionFactory class is in charge of the creation of concrete instances of minimizers.

It inherits most of its implementation from the Dynamic Factory base class. It is implemented as a singleton class.

Author
Anders Markvardsen, ISIS, RAL
Date
20/05/2010

Definition at line 36 of file CostFunctionFactory.h.

Constructor & Destructor Documentation

◆ CostFunctionFactoryImpl()

Mantid::API::CostFunctionFactoryImpl::CostFunctionFactoryImpl ( )
private

Private Constructor for singleton class.

Definition at line 13 of file CostFunctionFactory.cpp.

References Mantid::Kernel::SingletonHolder< T >::Instance().

Member Function Documentation

◆ createFunction()

ICostFunction * Mantid::API::CostFunctionFactoryImpl::createFunction ( const std::string &  type) const

Creates an instance of a cost function.

Parameters
type:: The function's type
Returns
A pointer to the created function

Friends And Related Function Documentation

◆ Mantid::Kernel::CreateUsingNew< CostFunctionFactoryImpl >

Definition at line 42 of file CostFunctionFactory.h.


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