Matrix Science header

ms_ms1quant_match_component.hpp

00001 /*
00002 ##############################################################################
00003 # file: ms_ms1quant_match_component.hpp
00004 # 'msparser' toolkit
00005 # 
00006 ##############################################################################
00007 # COPYRIGHT NOTICE
00008 # Copyright 1998-2014 Matrix Science Limited  All Rights Reserved.
00009 #
00010 ##############################################################################
00011  * @(#)$Source: /vol/cvsroot/parser/inc/ms_ms1quant_match_component.hpp,v $
00012  * @(#)$Revision: 1.4 $
00013  * @(#)$Date: 2017/01/31 13:10:16 $
00014 ##############################################################################
00015  */
00016 
00017 #ifndef MS_MS1QUANT_MATCH_COMPONENT_HPP
00018 #define MS_MS1QUANT_MATCH_COMPONENT_HPP
00019 
00020 #ifdef _WIN32
00021 #pragma warning(disable:4251)   // Don't want all classes to be exported
00022 #pragma warning(disable:4786)   // Debug symbols too long
00023 #   ifndef _MATRIX_USE_STATIC_LIB
00024 #       ifdef MS_MASCOTRESFILE_EXPORTS
00025 #           define MS_MASCOTRESFILE_API __declspec(dllexport)
00026 #           define MS_PARSERINTERAL_API __declspec(dllexport)
00027 #       else
00028 #           define MS_MASCOTRESFILE_API __declspec(dllimport)
00029 #           define MS_PARSERINTERAL_API __declspec(dllimport)
00030 #       endif
00031 #   else
00032 #       define MS_MASCOTRESFILE_API
00033 #       define MS_PARSERINTERAL_API
00034 #   endif
00035 #else
00036 #   define MS_MASCOTRESFILE_API
00037 #   define MS_PARSERINTERAL_API
00038 #endif
00039 
00040 // Includes from the standard template library
00041 #include <string>
00042 
00043 namespace matrix_science
00044 {
00045     //=========================================================================
00051     class ms_ms1quant_match_component_body;
00052 
00054 
00057     class MS_MASCOTRESFILE_API ms_ms1quant_match_component :
00058         public ms_handle
00059     {
00060         public:
00062             ms_ms1quant_match_component();
00063 
00065             ms_ms1quant_match_component(const ms_ms1quant_match_component_body & body);
00066 
00067 #ifndef SWIG
00068 
00069             ms_ms1quant_match_component_body * body();
00071             const ms_ms1quant_match_component_body * body() const;
00073             void removePeptide(const int q, const int p);
00074 #endif
00075 
00077             std::string getComponent() const;
00078 
00080             bool isComponentIdentified() const;
00081 
00083             double getRelativeMass() const;
00084 
00086             double getMoverz() const;
00087 
00089             std::string getVarModsStr() const;
00090 
00092             std::string getSummedModsStr() const;
00093 
00095             bool hasAbsoluteValue() const;
00096 
00098             double getAbsoluteValue() const;
00099 
00101             void setAbsoluteValue(double value);
00102 
00104             ms_xic getXic() const;
00105 
00107             ms_xic * getXicPtr();
00108 
00110             int getNumRanges() const;
00112             ms_ms1quant_match_range getRange(int index) const;
00113 
00114             void setRanges(std::vector<ms_ms1quant_match_range> ranges);
00115 
00117             int getNumPeptides() const;
00119             void getPeptideKey(int index, int & q, int & p) const;
00120     };
00121  // end of quantitation_group
00123     //=========================================================================
00124 
00125 } // namespace matrix_science
00126 
00127 #ifndef SWIG
00128 namespace msparser_internal
00129 {
00130     MS_PARSERINTERAL_API double calcRelMassFromMz(double mz, long charge);
00131     MS_PARSERINTERAL_API double calcMzFromRelMass(double mr, long charge);
00132 }
00133 #endif
00134 
00135 #endif // MS_MS1QUANT_MATCH_COMPONENT_HPP
00136 
00137 /*------------------------------- End of File -------------------------------*/
Copyright © 2016 Matrix Science Ltd.  All Rights Reserved. Generated on Fri Jun 2 2017 01:44:51