IonSource.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-2017.
//
// 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 $
// --------------------------------------------------------------------------

#ifndef OPENMS_METADATA_IONSOURCE_H
#define OPENMS_METADATA_IONSOURCE_H

#include <OpenMS/METADATA/MetaInfoInterface.h>

namespace OpenMS
{
  class OPENMS_DLLAPI IonSource :
    public MetaInfoInterface
  {
public:
    enum InletType
    {
      INLETNULL,                                                        
      DIRECT,                                                               
      BATCH,                                                                
      CHROMATOGRAPHY,                                               
      PARTICLEBEAM,                                                     
      MEMBRANESEPARATOR,                                        
      OPENSPLIT,                                                        
      JETSEPARATOR,                                                     
      SEPTUM,                                                               
      RESERVOIR,                                                        
      MOVINGBELT,                                                       
      MOVINGWIRE,                                                       
      FLOWINJECTIONANALYSIS,                                
      ELECTROSPRAYINLET,                                        
      THERMOSPRAYINLET,                                             
      INFUSION,                                                             
      CONTINUOUSFLOWFASTATOMBOMBARDMENT,        
      INDUCTIVELYCOUPLEDPLASMA,                             
      MEMBRANE,                                                             
      NANOSPRAY,                                                        
      SIZE_OF_INLETTYPE
    };
    static const std::string NamesOfInletType[SIZE_OF_INLETTYPE];

    enum IonizationMethod
    {
      IONMETHODNULL,        
      ESI,                              
      EI,                               
      CI,                               
      FAB,                              
      TSP,                              
      LD,                               
      FD,                               
      FI,                               
      PD,                               
      SI,                               
      TI,                               
      API,                              
      ISI,                              
      CID,                              
      CAD,                              
      HN,                               
      APCI,                             
      APPI,                             
      ICP,                              
      NESI,                             
      MESI,                             
      SELDI,                        
      SEND,                             
      FIB,                              
      MALDI,                        
      MPI,                              
      DI,                               
      FA,                               
      FII,                              
      GD_MS,                        
      NICI,                             
      NRMS,                             
      PI,                               
      PYMS,                             
      REMPI,                        
      AI,                               
      ASI,                              
      AD,                               
      AUI,                              
      CEI,                              
      CHEMI,                        
      DISSI,                        
      LSI,                              
      PEI,                              
      SOI,                              
      SPI,                              
      SUI,                              
      VI,                               
      AP_MALDI,                     
      SILI,                             
      SALDI,                        
      SIZE_OF_IONIZATIONMETHOD
    };
    static const std::string NamesOfIonizationMethod[SIZE_OF_IONIZATIONMETHOD];

    enum Polarity
    {
      POLNULL,      
      POSITIVE,   
      NEGATIVE,   
      SIZE_OF_POLARITY
    };
    static const std::string NamesOfPolarity[SIZE_OF_POLARITY];

    IonSource();
    IonSource(const IonSource & source);
    ~IonSource();

    IonSource & operator=(const IonSource & source);

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

    InletType getInletType() const;
    void setInletType(InletType inlet_type);

    IonizationMethod getIonizationMethod() const;
    void setIonizationMethod(IonizationMethod ionization_type);

    Polarity getPolarity() const;
    void setPolarity(Polarity polarity);

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

protected:
    InletType inlet_type_;
    IonizationMethod ionization_method_;
    Polarity polarity_;
    Int order_;

  };

} // namespace OpenMS

#endif // OPENMS_METADATA_IONSOURCE_H