AddSampleLog.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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 +
#pragma once
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/ExperimentInfo.h"
#include "MantidAPI/Run.h"
#include "MantidAlgorithms/DllConfig.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL AddSampleLog final : public API::Algorithm {
public:
  const std::string name() const override { return "AddSampleLog"; }
  const std::string summary() const override { return "Used to insert a value into the sample logs in a workspace."; }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override {
    return {"AddSampleLogMultiple", "AddTimeSeriesLog", "DeleteLog", "LoadLog"};
  }
  const std::string category() const override { return "DataHandling\\Logs"; }
 
private:
  void init() override;
  void exec() override;
 
  void addStringLog(API::Run &theRun, const std::string &propName, const std::string &propValue,
                    const std::string &propUnit);
 
  void addTimeSeriesProperty(API::Run &run_obj, const std::string &prop_name, const std::string &prop_value,
                             const std::string &prop_unit, const std::string &prop_number_type);
 
  void addSingleValueProperty(API::Run &theRun, const std::string &propName, const std::string &propValue,
                              const std::string &propUnit, const std::string &propNumberType);
 
  void setTimeSeriesData(API::Run &run_obj, const std::string &property_name, bool value_is_int);
 
  Types::Core::DateAndTime getRunStart(const API::Run &run_obj);
 
  std::vector<int> getIntValues(const API::MatrixWorkspace_const_sptr &dataws, int workspace_index);
 
  std::vector<double> getDblValues(const API::MatrixWorkspace_const_sptr &dataws, int workspace_index);
 
  std::vector<Types::Core::DateAndTime> getTimes(const API::MatrixWorkspace_const_sptr &dataws, int workspace_index,
                                                 bool is_epoch, bool is_second, API::Run &run_obj);
 
  void getMetaData(const API::MatrixWorkspace_const_sptr &dataws, bool &epochtime, std::string &timeunit);
};
 
} // namespace Algorithms
} // namespace Mantid