Sample.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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/DllConfig.h"
#include "MantidGeometry/Objects/CSGObject.h"
 
namespace Mantid {
namespace Nexus {
class File;
}
//-----------------------------------------------------------------------------
// Geometry forward declarations
//------------------------------------------------------------------------------
namespace Geometry {
class CrystalStructure;
class OrientedLattice;
class SampleEnvironment;
} // namespace Geometry
 
namespace API {
 
class MANTID_API_DLL Sample {
public:
  Sample();
  Sample(const Sample &copy);
  ~Sample();
  Sample &operator=(const Sample &rhs);
 
  void saveNexus(Nexus::File *file, const std::string &group) const;
  int loadNexus(Nexus::File *file, const std::string &group);
 
  Sample &operator[](const int index);
  std::size_t size() const;
  void addSample(const std::shared_ptr<Sample> &childSample);
 
  const std::string &getName() const;
  void setName(const std::string &name);
  bool hasShape() const;
  const Geometry::IObject &getShape() const;
  const Geometry::IObject_sptr getShapePtr() const;
  void setShape(const Geometry::IObject_sptr &shape);
 
  const Kernel::Material &getMaterial() const;
 
  bool hasEnvironment() const;
  const Geometry::SampleEnvironment &getEnvironment() const;
  void setEnvironment(std::shared_ptr<Geometry::SampleEnvironment> env);
 
  const Geometry::OrientedLattice &getOrientedLattice() const;
  Geometry::OrientedLattice &getOrientedLattice();
  void setOrientedLattice(std::unique_ptr<Geometry::OrientedLattice> lattice);
  bool hasOrientedLattice() const;
 
  const Geometry::CrystalStructure &getCrystalStructure() const;
  void setCrystalStructure(const Geometry::CrystalStructure &newCrystalStructure);
  bool hasCrystalStructure() const;
  void clearCrystalStructure();
 
  // Required for SANS work until we define a proper
  // sample object from the raw file information
 
  void setGeometryFlag(int geom_id);
  int getGeometryFlag() const;
  void setThickness(double thick);
  double getThickness() const;
  void setHeight(double height);
  double getHeight() const;
  void setWidth(double width);
  double getWidth() const;
 
  void clearOrientedLattice();
 
  bool operator==(const Sample &other) const;
  bool operator!=(const Sample &other) const;
 
private:
  std::string m_name;
  Geometry::IObject_sptr m_shape;
  std::shared_ptr<Geometry::SampleEnvironment> m_environment;
  std::unique_ptr<Geometry::OrientedLattice> m_lattice;
 
  std::unique_ptr<Geometry::CrystalStructure> m_crystalStructure;
 
  std::vector<std::shared_ptr<Sample>> m_samples;
 
  int m_geom_id;
  double m_thick;
  double m_height;
  double m_width;
};
 
} // namespace API
} // namespace Mantid