PeptideEvidence.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-2012.
//
// 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: Andreas Bertsch $
// $Authors: Andreas Bertsch $
// --------------------------------------------------------------------------

#ifndef OPENMS_METADATA_PEPTIDEEVIDENCE_H
#define OPENMS_METADATA_PEPTIDEEVIDENCE_H

#include <vector>

#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/DATASTRUCTURES/String.h>
#include <OpenMS/METADATA/MetaInfoInterface.h>

namespace OpenMS
{
  class AASequence;

  class OPENMS_DLLAPI PeptideEvidence :
    public MetaInfoInterface
  {
public:


    PeptideEvidence();

    PeptideEvidence(DoubleReal score,
                    UInt rank,
                    Int charge,
                    const AASequence & sequence);

    PeptideEvidence(const PeptideEvidence & source);

    virtual ~PeptideEvidence();

    PeptideEvidence & operator=(const PeptideEvidence & source);

    bool operator==(const PeptideEvidence & rhs) const;

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


    const String & getDBSequenceRef() const;

    void setDBSequenceRef(const String & rhs);

    const String & getTranslationTableRef() const;

    void setTranslationTableRef(const String & rhs);

    void setStart(Int start);

    Int getStart() const;

    void setEnd(Int end);

    Int getEnd() const;

    void setPre(char rhs);

    char getPre() const;

    void setPost(char rhs);

    char getPost() const;

    void setId(const String & id);

    const String & getId() const;

    void setName(const String & name);

    const String & getName() const;

    void setMissedCleavages(Int rhs);

    Int getMissedCleavages() const;

    void setIsDecoy(bool is_decoy);

    bool getIsDecoy() const;

    void setFrame(Int frame);

    Int getFrame() const;


protected:

    String db_sequence_ref_;
    String translation_table_ref_;
    Int start_;
    Int end_;
    char pre_;
    char post_;
    String id_;
    String name_;
    Int missed_cleavages_;
    bool is_decoy_;
    Int frame_;

  };

} // namespace OpenMS

#endif // OPENMS_METADATA_PEPTIDEEVIDENCE_H