Matrix Science header

ms_ms1quant_match_ratio.hpp

00001 /*
00002 ##############################################################################
00003 # file: ms_ms1quant_match_ratio.hpp
00004 # 'msparser' toolkit
00005 # An extracted ion chromatogram
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_ratio.hpp,v $
00012  * @(#)$Revision: 1.5 $
00013  * @(#)$Date: 2017/01/31 13:10:16 $
00014 ##############################################################################
00015  */
00016 
00017 #ifndef MS_MS1QUANT_MATCH_RATIO_HPP
00018 #define MS_MS1QUANT_MATCH_RATIO_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 #       else
00027 #           define MS_MASCOTRESFILE_API __declspec(dllimport)
00028 #       endif
00029 #   else
00030 #       define MS_MASCOTRESFILE_API
00031 #   endif
00032 #else
00033 #   define MS_MASCOTRESFILE_API
00034 #endif
00035 
00036 // Includes from the standard template library
00037 #include <string>
00038 #include <vector>
00039 
00040 namespace matrix_science
00041 {
00042     //=========================================================================
00048     class ms_ms1quant_match_ratio_body;
00049     class ms_quant_method;
00050     class ms_fitexy_result;
00051 
00053 
00056     class MS_MASCOTRESFILE_API ms_ms1quant_match_ratio :
00057         public ms_handle
00058     {
00059         public:
00061 
00064             enum ratioStatusCode
00065             {
00066                 RS_EMPTY = 0,                   
00067                 RS_OK = 1,                      
00068                 RS_ISOLATEDPRECURSORFAILED = 2, 
00069                 RS_INTEFERENCEFAILED = 4,       
00070                 RS_NODATA = 8,                  
00071                 RS_FITEXYSIGMA = 16,            
00072                 RS_NEGATIVERATIO = 32,          
00073                 RS_INFINITERATIO = 64,          
00074                 RS_ZERORATIO = 128,             
00075                 RS_OUTLIER = 256,               
00076             };
00077 
00079             static std::string getXmlCode(ratioStatusCode code);
00080 
00082             static ratioStatusCode getCodeFromXml(std::string text);
00083 
00085             static bool getCodeInfo(ratioStatusCode code, const ms_quant_method & method, double & info);
00086 
00088             ms_ms1quant_match_ratio();
00089 
00091             ms_ms1quant_match_ratio(const ms_ms1quant_match_ratio_body & body);
00092 
00094             std::string getRatioName() const;
00095 
00097             bool isSet() const;
00098 
00100             double getValue() const;
00101 
00103             double getQuality() const;
00104 
00106             bool isValid() const;
00107 
00109             bool isUsedForAverage() const;
00110 
00112             bool isIncluded() const;
00113 
00115             bool getFitexy(ms_fitexy_result & value) const;
00116 
00118             int getStatus() const;
00119 
00121             std::vector<ratioStatusCode> getStatusList() const;
00122 
00123 #ifndef SWIG
00124 
00125             ms_ms1quant_match_ratio_body * body();
00127             const ms_ms1quant_match_ratio_body * body() const;
00129             void setStatus(const int status);
00131             void setValid(const bool valid);
00133             void setInclude(const bool include);
00135             void setFitexy(const ms_fitexy_result & value);
00137             void setValue(const std::string & ratioName, double value, double quality, bool usedForAverage, bool include);
00138 #endif
00139     };
00140  // end of quantitation_group
00142     //=========================================================================
00143 
00144 } // namespace matrix_science
00145 
00146 #endif // MS_MS1QUANT_MATCH_RATIO_HPP
00147 
00148 /*------------------------------- End of File -------------------------------*/
Copyright © 2016 Matrix Science Ltd.  All Rights Reserved. Generated on Fri Jun 2 2017 01:44:51