ExperimentalSettings.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 <OpenMS/METADATA/Sample.h>
#include <OpenMS/METADATA/MetaInfoInterface.h>
#include <OpenMS/METADATA/HPLC.h>
#include <OpenMS/METADATA/SourceFile.h>
#include <OpenMS/METADATA/ContactPerson.h>
#include <OpenMS/METADATA/Instrument.h>
#include <OpenMS/METADATA/DocumentIdentifier.h>
#include <OpenMS/METADATA/ProteinIdentification.h>
 
#include <vector>
 
namespace OpenMS
{
  class OPENMS_DLLAPI ExperimentalSettings :
    public MetaInfoInterface,
    public DocumentIdentifier
  {
public:
 
    ExperimentalSettings() = default;
    ExperimentalSettings(const ExperimentalSettings &) = default;
    ExperimentalSettings(ExperimentalSettings &&) = default;
    ~ExperimentalSettings() override;
 
    ExperimentalSettings & operator=(const ExperimentalSettings &) = default;
    ExperimentalSettings & operator=(ExperimentalSettings &&) = default;
 
    bool operator==(const ExperimentalSettings & rhs) const;
    bool operator!=(const ExperimentalSettings & rhs) const;
 
    const Sample & getSample() const;
    Sample & getSample();
    void setSample(const Sample & sample);
 
    const std::vector<SourceFile> & getSourceFiles() const;
    std::vector<SourceFile> & getSourceFiles();
    void setSourceFiles(const std::vector<SourceFile> & source_files);
 
    const std::vector<ContactPerson> & getContacts() const;
    std::vector<ContactPerson> & getContacts();
    void setContacts(const std::vector<ContactPerson> & contacts);
 
    const Instrument & getInstrument() const;
    Instrument & getInstrument();
    void setInstrument(const Instrument & instrument);
 
    const HPLC & getHPLC() const;
    HPLC & getHPLC();
    void setHPLC(const HPLC & hplc);
 
    const DateTime & getDateTime() const;
    void setDateTime(const DateTime & date);
 
    const String & getComment() const;
    void setComment(const String & comment);
 
    const std::vector<ProteinIdentification> & getProteinIdentifications() const;
    std::vector<ProteinIdentification> & getProteinIdentifications();
    void setProteinIdentifications(const std::vector<ProteinIdentification> & protein_identifications);
 
    const String & getFractionIdentifier() const;
    void setFractionIdentifier(const String & fraction_identifier);
 
protected:
    Sample sample_;
    std::vector<SourceFile> source_files_;
    std::vector<ContactPerson> contacts_;
    Instrument instrument_;
    HPLC hplc_;
    DateTime datetime_;
    String comment_;
    std::vector<ProteinIdentification> protein_identifications_;
    String fraction_identifier_;
  };
 
  OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, const ExperimentalSettings & exp);
 
} // namespace OpenMS