ms_ms1quant_match_ratio.hpp

/*
##############################################################################
# file: ms_ms1quant_match_ratio.hpp
# 'msparser' toolkit
# An extracted ion chromatogram
##############################################################################
# COPYRIGHT NOTICE
# Copyright 1998-2014 Matrix Science Limited  All Rights Reserved.
#
##############################################################################
 * @(#)$Source: parser/inc/ms_ms1quant_match_ratio.hpp $
 * @(#)$Revision: 8e4151b262f3acce03627aeb892da3923c8383b8 | MSPARSER_REL_3_0_0-2024-09-24-0-g93ebaeb4f4 $
 * @(#)$Date: 2021-06-15 17:07:47 +0100 $
##############################################################################
 */
 
#ifndef MS_MS1QUANT_MATCH_RATIO_HPP
#define MS_MS1QUANT_MATCH_RATIO_HPP
 
 
// Includes from the standard template library
#include <string>
#include <vector>
 
namespace matrix_science
{
    //=========================================================================
    class ms_ms1quant_match_ratio_body;
    class ms_quant_method;
    class ms_fitexy_result;
 
 
    class MS_MASCOTRESFILE_API ms_ms1quant_match_ratio :
        public ms_handle
    {
        public:
 
            enum ratioStatusCode
            {
                RS_EMPTY = 0,                   
                RS_OK = 1,                      
                RS_ISOLATEDPRECURSORFAILED = 2, 
                RS_INTEFERENCEFAILED = 4,       
                RS_NODATA = 8,                  
                RS_FITEXYSIGMA = 16,            
                RS_NEGATIVERATIO = 32,          
                RS_INFINITERATIO = 64,          
                RS_ZERORATIO = 128,             
                RS_DO_NOT_USE = 256,            
                RS_TOTALINTENSITYFAILED = 512,  
                RS_VALID_FLAGS = RS_OK | RS_ISOLATEDPRECURSORFAILED | RS_INTEFERENCEFAILED | RS_NODATA | RS_FITEXYSIGMA | RS_NEGATIVERATIO | RS_INFINITERATIO | RS_ZERORATIO | RS_TOTALINTENSITYFAILED
            };
 
            static std::string getXmlCode(ratioStatusCode code);
 
            static ratioStatusCode getCodeFromXml(std::string text);
 
            static bool getCodeInfo(ratioStatusCode code, const ms_quant_method & method, double & info);
 
            ms_ms1quant_match_ratio();
 
            ms_ms1quant_match_ratio(const ms_ms1quant_match_ratio_body & body);
 
            std::string getRatioName() const;
 
            bool isSet() const;
 
            double getValue() const;
 
            double getQuality() const;
 
            bool isValid() const;
 
            bool isUsedForAverage() const;
 
            bool isIncluded() const;
 
            bool getFitexy(ms_fitexy_result & value) const;
 
            int getStatus() const;
 
            std::vector<ratioStatusCode> getStatusList() const;
 
#ifndef SWIG
            ms_ms1quant_match_ratio_body * body();
            const ms_ms1quant_match_ratio_body * body() const;
            void setStatus(const int status);
            void setValid(const bool valid);
            void setInclude(const bool include);
            void setFitexy(const ms_fitexy_result & value);
            void setValue(const std::string & ratioName, double value, double quality, bool usedForAverage, bool include);
#endif
    };
 // end of quantitation_group
    //=========================================================================
 
} // namespace matrix_science
 
#endif // MS_MS1QUANT_MATCH_RATIO_HPP
 
/*------------------------------- End of File -------------------------------*/