AddSampleLog.h

#ifndef MANTID_ALGORITHMS_ADDSAMPLELOG_H_
#define MANTID_ALGORITHMS_ADDSAMPLELOG_H_

//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"

namespace Mantid
{
namespace Algorithms
{
/**
    Used to insert a single string into the sample in a workspace

    Required Properties:
    <UL>
    <LI> Workspace -The log data will be added to this workspace</LI>
    <LI> LogName -The named entry will be accessible through this name</LI>
    Optional property:
    <LI> LogText -The log data</LI>
    </UL>

    Workspaces contain information in logs. Often these detail what happened
    to the sample during the experiment. This algorithm allows one named log
    to be entered.

    Copyright &copy; 2009-2010 STFC Rutherford Appleton Laboratory

    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>
    Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport AddSampleLog : public API::Algorithm
{
public:
  /// (Empty) Constructor
  AddSampleLog() : API::Algorithm() {}
  /// Virtual destructor
  virtual ~AddSampleLog() {}
  /// Algorithm's name
  virtual const std::string name() const { return "AddSampleLog"; }
  /// Algorithm's version
  virtual const int version() const { return (1); }
  /// Algorithm's category for identification
  virtual const std::string category() const { return "DataHandling\\Logs"; }

private:
  /// Initialisation code
  void init();
  /// Execution code
  void exec();
};

} // namespace Algorithms
} // namespace Mantid

#endif /*MANTID_ALGORITHMS_ADDSAMPLELOG_H_*/