Sample.h

Go to the documentation of this file.

// Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <list>
 
#include <OpenMS/DATASTRUCTURES/String.h>
#include <OpenMS/METADATA/MetaInfoInterface.h>
#include <OpenMS/CONCEPT/Exception.h>
 
namespace OpenMS
{
  class SampleTreatment;
 
  class OPENMS_DLLAPI Sample :
    public MetaInfoInterface
  {
public:
    enum SampleState {SAMPLENULL, SOLID, LIQUID, GAS, SOLUTION, EMULSION, SUSPENSION, SIZE_OF_SAMPLESTATE};
    static const std::string NamesOfSampleState[SIZE_OF_SAMPLESTATE];
 
    Sample();
    Sample(const Sample & source);
    Sample(Sample&&) = default;
    ~Sample();
 
    Sample & operator=(const Sample & source);
    Sample& operator=(Sample&&) & = default;
 
    bool operator==(const Sample & rhs) const;
 
    const String & getName() const;
    void setName(const String & name);
 
    const String & getOrganism() const;
    void setOrganism(const String & organism);
 
    const String & getNumber() const;
    void setNumber(const String & number);
 
    const String & getComment() const;
    void setComment(const String & comment);
 
    SampleState getState() const;
    void setState(SampleState state);
 
    double getMass() const;
    void setMass(double mass);
 
    double getVolume() const;
    void setVolume(double volume);
 
    double getConcentration() const;
    void setConcentration(double concentration);
 
    std::vector<Sample> & getSubsamples();
    const std::vector<Sample> & getSubsamples() const;
    void setSubsamples(const std::vector<Sample> & subsamples);
 
    void addTreatment(const SampleTreatment & treatment, Int before_position = -1);
 
    SampleTreatment & getTreatment(UInt position);
 
    const SampleTreatment & getTreatment(UInt position) const;
 
    void removeTreatment(UInt position);
 
    Int countTreatments() const;
 
protected:
    String name_;
    String number_;
    String comment_;
    String organism_;
    SampleState state_;
    double mass_;
    double volume_;
    double concentration_;
    std::vector<Sample> subsamples_;
 
    // note: default move constructor / assignment operator will work on this,
    // since it will move the whole vector over to the new object who will then
    // own the memory.
    std::list<SampleTreatment *> treatments_;
 
  };
} // namespace OpenMS