WorkspaceFactory.h

#ifndef MANTID_WORKSPACEFACTORY_H_
#define MANTID_WORKSPACEFACTORY_H_

/* Used to register classes into the factory. creates a global object in an 
 * anonymous namespace. The object itself does nothing, but the comma operator
 * is used in the call to its constructor to effect a call to the factory's 
 * subscribe method.
 */
#define DECLARE_WORKSPACE(classname) \
  namespace { \
    Mantid::RegistrationHelper register_ws_##classname( \
       ((Mantid::WorkspaceFactory::Instance()->subscribe<Mantid::classname>(#classname)) \
       , 0)); \
  }

//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "DynamicFactory.h"

namespace Mantid
{

//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
class Workspace;

/** @class WorkspaceFactory WorkspaceFactory.h Kernel/WorkspaceFactory.h

    The WorkspaceFactory class is in charge of the creation of all types
    of workspaces. It inherits most of its implementation from
    the Dynamic Factory base class.
    It is implemented as a singleton class.
    
    @author Laurent C Chapon, ISIS, RAL
    @author Russell Taylor, Tessella Support Services plc
    @date 26/09/2007
    
    Copyright &copy; 2007 ???RAL???

    This file is part of Mantid.

    Mantid is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    Mantid is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

    File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid>    
*/

class DLLExport WorkspaceFactory : public DynamicFactory<Workspace>
{
public:
  
  /** A static method which retrieves the single instance of the Algorithm Factory
   * 
   *  @returns A pointer to the factory instance
   */
  static WorkspaceFactory* Instance();
  
private:
  
  /// Private Constructor for singleton class
  WorkspaceFactory();
  
  /** Private destructor
   *  Prevents client from calling 'delete' on the pointer handed 
   *  out by Instance
   */
  virtual ~WorkspaceFactory();
    
  ///static reference to the logger class
  static Logger& g_log;

  /// Pointer to the factory instance
  static WorkspaceFactory* m_instance;
};

} // namespace Mantid

#endif /*MANTID_WORKSPACEFACTORY_H_*/