ms_peptide_quant_key.hpp

/*
##############################################################################
# file: ms_peptide_quant_key.hpp                                             #
# 'msparser' toolkit                                                         #
# Peptide quantitation key used in ms_quantitation                           #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2012 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
#     $Author: villek@matrixscience.com $ #
#       $Date: 2018-07-30 16:23:53 +0100 $ #
#   $Revision: #
# $NoKeywords::                                                            $ #
##############################################################################
*/
 
#ifndef MS_PEPQUANTKEY_HPP
#define MS_PEPQUANTKEY_HPP
 
 
// Includes from the standard template library
#include <string>
 
namespace matrix_science {
 
    class MS_MASCOTRESFILE_API ms_peptide_quant_key
    {
        public:
            ms_peptide_quant_key();
 
            ms_peptide_quant_key(int q, int p);
 
            ms_peptide_quant_key(int q, int p, int charge);
 
            explicit ms_peptide_quant_key(int ID);
 
            explicit ms_peptide_quant_key(const std::string &opaqueString);
 
            explicit ms_peptide_quant_key(const std::string &opaqueString, int ID);
 
            ms_peptide_quant_key(const ms_peptide_quant_key& src);
 
            ~ms_peptide_quant_key();
 
#ifndef SWIG
            ms_peptide_quant_key& operator=(const ms_peptide_quant_key& right);
 
            bool operator<(const ms_peptide_quant_key& right) const;
 
            bool operator<=(const ms_peptide_quant_key& right) const;
 
            bool operator>(const ms_peptide_quant_key& right) const;
 
            bool operator>=(const ms_peptide_quant_key& right) const;
 
            bool operator==(const ms_peptide_quant_key& right) const;
 
            bool operator!=(const ms_peptide_quant_key& right) const;
#endif
 
 
#ifndef SWIG
            bool getQueryAndRank(int &q, int &p) const;
 
            bool getCharge(int &charge) const;
 
            bool getID(int &ID) const;
 
            bool getOpaqueString(std::string & opaqueStringRef) const;
 
            bool getOpaqueStringAndID(std::string & opaqueStringRef, int & ID) const;
#else // SWIG Multiple return values
            bool getQueryAndRank(int & OUTPUT, int & OUTPUT) const;
            bool getCharge(int &OUTPUT) const;
            bool getID(int &OUTPUT) const;
            bool getOpaqueString(std::string & OUTPUT) const;
            bool getOpaqueStringAndID(std::string & OUTPUT, int & OUTPUT) const;
#endif
 
            bool isNil() const;
 
            static ms_peptide_quant_key fromSerialisedString(const std::string &serialisedStr);
 
            std::string serialise() const;
 
            static std::string serialisationFormatVersion();
 
        private:
            enum PEPQUANTKEY_TYPE {
                PEPQUANTKEY_NIL,
                PEPQUANTKEY_QP,
                PEPQUANTKEY_QPCHARGE,
                PEPQUANTKEY_ID,
                PEPQUANTKEY_OPAQUE,
                PEPQUANTKEY_OPAQUEID
            };
 
            int type_, q_, p_, charge_, ID_;
            std::string *opaqueString_;
    }; // end of quantitation_group
}   // matrix_science namespace
 
#endif // MS_PEPQUANTKEY_HPP
 
/*------------------------------- End of File -------------------------------*/