Adduct.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-2023.
//
// 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: Chris Bielow $
// $Authors: $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/OpenMSConfig.h>
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/DATASTRUCTURES/String.h>
 
namespace OpenMS
{
 
  class OPENMS_DLLAPI Adduct
  {
public:
 
    typedef std::vector<Adduct> AdductsType;
 
    Adduct();
 
    Adduct(Int charge);
 
    Adduct(Int charge, Int amount, double singleMass, const String& formula, double log_prob, double rt_shift, const String& label = "");
 
    Adduct operator*(const Int m) const;
    Adduct operator+(const Adduct& rhs);
    void operator+=(const Adduct& rhs);
 
 
    friend OPENMS_DLLAPI std::ostream& operator<<(std::ostream& os, const Adduct& a);
 
    friend OPENMS_DLLAPI bool operator==(const Adduct& a, const Adduct& b);
 
    const Int& getCharge() const;
 
    void setCharge(const Int& charge);
 
    const Int& getAmount() const;
    void setAmount(const Int& amount);
 
    const double& getSingleMass() const;
    void setSingleMass(const double& singleMass);
 
    const double& getLogProb() const;
    void setLogProb(const double& log_prob);
 
    const String& getFormula() const;
    void setFormula(const String& formula);
 
    const double& getRTShift() const;
    const String& getLabel() const;
 
    // convert a ion string to adduct string with charge information (eg. ion_string = "Na1", charge = "1" --> "[M+Na]+")
    String toAdductString(const String& ion_string, const Int& charge);
    //}
 
private:
    Int charge_; 
    Int amount_; 
    double singleMass_; 
    double log_prob_; 
    String formula_; 
    double rt_shift_; 
    String label_; 
 
    String checkFormula_(const String& formula);
 
  };
 
} // namespace OpenMS