Instrument.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/StringUtils.h>
#include <OpenMS/METADATA/MetaInfoInterface.h>
#include <OpenMS/METADATA/IonSource.h>
#include <OpenMS/METADATA/MassAnalyzer.h>
#include <OpenMS/METADATA/IonDetector.h>
#include <OpenMS/METADATA/Software.h>
#include <OpenMS/DATASTRUCTURES/ListUtils.h>
 
#include <vector>
 
namespace OpenMS
{
  class OPENMS_DLLAPI Instrument :
    public MetaInfoInterface
  {
 
public:
 
    enum class IonOpticsType
    {
      UNKNOWN,                  
      MAGNETIC_DEFLECTION,      
      DELAYED_EXTRACTION,       
      COLLISION_QUADRUPOLE,     
      SELECTED_ION_FLOW_TUBE,   
      TIME_LAG_FOCUSING,        
      REFLECTRON,               
      EINZEL_LENS,              
      FIRST_STABILITY_REGION,   
      FRINGING_FIELD,           
      KINETIC_ENERGY_ANALYZER,  
      STATIC_FIELD,             
      SIZE_OF_IONOPTICSTYPE
    };
 
    static const std::string NamesOfIonOpticsType[static_cast<size_t>(IonOpticsType::SIZE_OF_IONOPTICSTYPE)];
 
    static StringList getAllNamesOfIonOpticsType();
 
    Instrument();
    Instrument(const Instrument &) = default;
    Instrument(Instrument&&) = default;
    ~Instrument();
 
    Instrument & operator=(const Instrument &) = default;
    Instrument& operator=(Instrument&&) & = default;
 
    bool operator==(const Instrument & rhs) const;
    bool operator!=(const Instrument & rhs) const;
 
    const std::string & getName() const;
    void setName(const std::string & name);
 
    const std::string & getVendor() const;
    void setVendor(const std::string & vendor);
 
    const std::string & getModel() const;
    void setModel(const std::string & model);
 
    const std::string & getCustomizations() const;
    void setCustomizations(const std::string & customizations);
 
    const std::vector<IonSource> & getIonSources() const;
    std::vector<IonSource> & getIonSources();
    void setIonSources(const std::vector<IonSource> & ion_sources);
 
    const std::vector<MassAnalyzer> & getMassAnalyzers() const;
    std::vector<MassAnalyzer> & getMassAnalyzers();
    void setMassAnalyzers(const std::vector<MassAnalyzer> & mass_analyzers);
 
    const std::vector<IonDetector> & getIonDetectors() const;
    std::vector<IonDetector> & getIonDetectors();
    void setIonDetectors(const std::vector<IonDetector> & ion_detectors);
 
    const Software & getSoftware() const;
    Software & getSoftware();
    void setSoftware(const Software & software);
 
    IonOpticsType getIonOptics() const;
    void setIonOptics(IonOpticsType ion_optics);
 
protected:
 
    std::string name_;
    std::string vendor_;
    std::string model_;
    std::string customizations_;
    std::vector<IonSource> ion_sources_;
    std::vector<MassAnalyzer> mass_analyzers_;
    std::vector<IonDetector> ion_detectors_;
    Software software_;
    IonOpticsType ion_optics_;
  };
} // namespace OpenMS