SaveDetectorsGrouping.h

#ifndef MANTID_DATAHANDLING_SAVEDETECTORSGROUPING_H_
#define MANTID_DATAHANDLING_SAVEDETECTORSGROUPING_H_

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

namespace Mantid {
namespace DataHandling {

/** SaveDetectorsGrouping : TODO: DESCRIPTION

  @date 2011-11-16

  Copyright © 2011 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
  National Laboratory & European Spallation Source

  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://github.com/mantidproject/mantid>
  Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport SaveDetectorsGrouping : public API::Algorithm {
public:
  /// Algorithm's name for identification
  const std::string name() const override { return "SaveDetectorsGrouping"; };
  /// Summary of algorithms purpose
  const std::string summary() const override {
    return "Save a GroupingWorkspace to an XML file.";
  }

  /// Algorithm's version for identification
  int version() const override { return 1; };
  /// Algorithm's category for identification
  const std::string category() const override {
    return "DataHandling\\Grouping;Transforms\\Grouping";
  }

private:
  /// Define input parameters
  void init() override;

  /// Main body to execute algorithm
  void exec() override;

  /// Create map for GroupID -- vector<detector ID>
  void
  createGroupDetectorIDMap(std::map<int, std::vector<detid_t>> &groupwkspmap);

  /// Convert vector of detector ID to range of Detector ID
  void convertToDetectorsRanges(
      std::map<int, std::vector<detid_t>> groupdetidsmap,
      std::map<int, std::vector<detid_t>> &groupdetidrangemap);

  /// Print Grouping to XML file
  void printToXML(std::map<int, std::vector<detid_t>> groupdetidrangemap,
                  std::string xmlfilename);

  // GroupingWorkspace
  DataObjects::GroupingWorkspace_const_sptr mGroupWS;
};

} // namespace DataHandling
} // namespace Mantid

#endif /* MANTID_DATAHANDLING_SAVEDETECTORSGROUPING_H_ */