IonDetector.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2022.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------

#pragma once

#include <OpenMS/METADATA/MetaInfoInterface.h>

namespace OpenMS
{
  class OPENMS_DLLAPI IonDetector :
    public MetaInfoInterface
  {
public:
    enum Type
    {
      TYPENULL,                                  
      ELECTRONMULTIPLIER,                        
      PHOTOMULTIPLIER,                           
      FOCALPLANEARRAY,                           
      FARADAYCUP,                                
      CONVERSIONDYNODEELECTRONMULTIPLIER,        
      CONVERSIONDYNODEPHOTOMULTIPLIER,           
      MULTICOLLECTOR,                            
      CHANNELELECTRONMULTIPLIER,                 
      CHANNELTRON,                               
      DALYDETECTOR,                              
      MICROCHANNELPLATEDETECTOR,                 
      ARRAYDETECTOR,                             
      CONVERSIONDYNODE,                          
      DYNODE,                                    
      FOCALPLANECOLLECTOR,                       
      IONTOPHOTONDETECTOR,                       
      POINTCOLLECTOR,                            
      POSTACCELERATIONDETECTOR,                  
      PHOTODIODEARRAYDETECTOR,                   
      INDUCTIVEDETECTOR,                         
      ELECTRONMULTIPLIERTUBE,                    
      SIZE_OF_TYPE
    };
    static const std::string NamesOfType[SIZE_OF_TYPE];

    enum AcquisitionMode
    {
      ACQMODENULL,             
      PULSECOUNTING,           
      ADC,                     
      TDC,                     
      TRANSIENTRECORDER,       
      SIZE_OF_ACQUISITIONMODE
    };
    static const std::string NamesOfAcquisitionMode[SIZE_OF_ACQUISITIONMODE];

    IonDetector();
    IonDetector(const IonDetector &) = default;
    IonDetector(IonDetector&&) = default;
    ~IonDetector();

    IonDetector & operator=(const IonDetector &) = default;
    IonDetector& operator=(IonDetector&&) & = default;

    bool operator==(const IonDetector & rhs) const;
    bool operator!=(const IonDetector & rhs) const;

    Type getType() const;
    void setType(Type type);

    AcquisitionMode getAcquisitionMode() const;
    void setAcquisitionMode(AcquisitionMode acquisition_mode);

    double getResolution() const;
    void setResolution(double resolution);

    double getADCSamplingFrequency() const;
    void setADCSamplingFrequency(double ADC_sampling_frequency);

    Int getOrder() const;
    void setOrder(Int order);

protected:
    Type type_;
    AcquisitionMode acquisition_mode_;
    double resolution_;
    double ADC_sampling_frequency_;
    Int order_;

  };
} // namespace OpenMS