InspectInfile.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: $
// --------------------------------------------------------------------------

#ifndef OPENMS_FORMAT_INSPECTINFILE_H
#define OPENMS_FORMAT_INSPECTINFILE_H

#include <OpenMS/DATASTRUCTURES/String.h>

#include <map>

namespace OpenMS
{
  class OPENMS_DLLAPI InspectInfile
  {
public:

    InspectInfile();

    InspectInfile(const InspectInfile& inspect_infile);

    virtual ~InspectInfile();

    InspectInfile& operator=(const InspectInfile& inspect_infile);

    bool operator==(const InspectInfile& inspect_infile) const;

    void store(const String& filename);

    void handlePTMs(const String& modification_line, const String& modifications_filename, const bool monoisotopic);

    const String& getSpectra() const;
    void setSpectra(const String& spectra);

    const String& getDb() const;
    void setDb(const String& db);

    const String& getEnzyme() const;
    void setEnzyme(const String& enzyme);

    Int getModificationsPerPeptide() const;
    void setModificationsPerPeptide(Int modifications_per_peptide);

    UInt getBlind() const;
    void setBlind(UInt blind);

    float getMaxPTMsize() const;
    void setMaxPTMsize(float maxptmsize);

    float getPrecursorMassTolerance() const;
    void setPrecursorMassTolerance(float precursor_mass_tolerance);

    float getPeakMassTolerance() const;
    void setPeakMassTolerance(float peak_mass_tolerance);

    UInt getMulticharge() const;
    void setMulticharge(UInt multicharge);

    const String& getInstrument() const;
    void setInstrument(const String& instrument);

    Int getTagCount() const;
    void setTagCount(Int TagCount);

    const std::map<String, std::vector<String> >& getModifications() const;

private:

    String spectra_; 

    String db_; 

    String enzyme_; 

    Int modifications_per_peptide_; 

    UInt blind_; 

    float maxptmsize_; 

    float precursor_mass_tolerance_; 

    float peak_mass_tolerance_; 

    UInt multicharge_; 

    String instrument_; 

    Int tag_count_; 

    std::map<String, std::vector<String> > PTMname_residues_mass_type_; 

  };

} // namespace OpenMS

#endif // OPENMS_FORMAT_INSPECTINFILE_H