Skip to content
Snippets Groups Projects
CreateGroupingWorkspace.h 1.26 KiB
Newer Older
#ifndef MANTID_ALGORITHMS_CREATEGROUPINGWORKSPACE_H_
#define MANTID_ALGORITHMS_CREATEGROUPINGWORKSPACE_H_

#include "MantidKernel/System.h"
#include "MantidAPI/Algorithm.h"

namespace Mantid {
namespace Algorithms {

/** Creates a new GroupingWorkspace using an instrument from one of:
 *  an input workspace,
 *  an instrument name,
 *  or an instrument IDF file.
 *
 *  Optionally uses bank names to create the groups.
 */
class DLLExport CreateGroupingWorkspace : public API::Algorithm {
public:
  /// Algorithm's name for identification
  const std::string name() const override;
  /// Summary of algorithms purpose
  const std::string summary() const override {
    return "Creates a new GroupingWorkspace using an instrument from one of: "
           "an input workspace, an instrument name, or an instrument IDF "
           "file.\nOptionally uses bank names to create the groups.";
  }

  /// Algorithm's version for identification
  int version() const override;
  /// Algorithm's category for identification
  const std::string category() const override;

private:
  /// Initialise the properties
  void init() override;
  /// Run the algorithm
  void exec() override;
#endif /* MANTID_ALGORITHMS_CREATEGROUPINGWORKSPACE_H_ */