Comment.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#include "MantidAlgorithms/Comment.h"
#include "MantidKernel/MandatoryValidator.h"
 
namespace Mantid::Algorithms {
 
using Mantid::API::Workspace;
using Mantid::API::WorkspaceProperty;
using Mantid::Kernel::Direction;
using Mantid::Kernel::MandatoryValidator;
 
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(Comment)
 
//----------------------------------------------------------------------------------------------
 
 
const std::string Comment::name() const { return "Comment"; }
 
int Comment::version() const { return 1; }
 
const std::string Comment::category() const { return "Utility\\Workspaces"; }
 
const std::string Comment::summary() const { return "Adds a comment into the history record of a workspace"; }
 
//----------------------------------------------------------------------------------------------
void Comment::init() {
  declareProperty(std::make_unique<WorkspaceProperty<Workspace>>("Workspace", "", Direction::InOut),
                  "An InOut workspace that will store the new history comment");
 
  declareProperty("Text", "", std::make_shared<MandatoryValidator<std::string>>(),
                  "The text you want to store in the history of the workspace", Direction::Input);
 
  // always record history for this algorithm
  enableHistoryRecordingForChild(true);
}
 
//----------------------------------------------------------------------------------------------
void Comment::exec() {
  // do nothing
}
 
} // namespace Mantid::Algorithms