Matrix Science header

ms_quant_integration.hpp

00001 /*
00002 ##############################################################################
00003 # file: ms_quant_integration.hpp                                             #
00004 # 'msparser' toolkit                                                         #
00005 # Encapsulates integration-element from "quantitation.xml"-file              #
00006 ##############################################################################
00007 # COPYRIGHT NOTICE                                                           #
00008 # Copyright 1998-2006 Matrix Science Limited  All Rights Reserved.           #
00009 #                                                                            #
00010 ##############################################################################
00011  * @(#)$Source: /vol/cvsroot/parser/inc/ms_quant_integration.hpp,v $
00012  * @(#)$Revision: 1.12 $
00013  * @(#)$Date: 2010/09/06 16:18:57 $
00014 ##############################################################################
00015  */
00016 
00017 #ifndef MS_QUANT_INTEGRATION_HPP
00018 #define MS_QUANT_INTEGRATION_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 #include <string>
00037 #include <vector>
00038 
00039 // forward declarations
00040 namespace msparser_internal {
00041     class ms_quant_xmlloader;
00042     class ms_quant_integration_impl;
00043 }
00044 
00045 
00046 namespace matrix_science {
00047 
00048     class ms_xml_schema; // forward declaration
00049 
00055 
00056 
00060     class MS_MASCOTRESFILE_API ms_quant_integration: public ms_quant_parameters
00061     {
00062         friend class msparser_internal::ms_quant_xmlloader;
00063     public:
00065         ms_quant_integration();
00066 
00068         ms_quant_integration(const ms_quant_integration& src);
00069 
00071         virtual ~ms_quant_integration();
00072 
00074         void defaultValues();
00075 
00077         void copyFrom(const ms_quant_integration* right);
00078 
00079 #ifndef SWIG
00080 
00081         ms_quant_integration& operator=(const ms_quant_integration& right);
00082 #endif
00083 
00084         virtual std::string getSchemaType() const;
00085 
00087         virtual std::string validateShallow(const ms_xml_schema *pSchemaFileObj) const;
00088 
00090         virtual std::string validateDeep(const ms_xml_schema *pSchemaFileObj) const;
00091 
00092 
00094         bool haveMethod() const;
00095 
00097         std::string getMethod() const;
00098 
00100         void setMethod(const char* value);
00101 
00103         void dropMethod();
00104 
00106         std::string getMethodSchemaType() const;
00107 
00108 
00110         bool haveSource() const;
00111 
00113         std::string getSource() const;
00114 
00116         void setSource(const char* value);
00117 
00119         void dropSource();
00120 
00122         std::string getSourceSchemaType() const;
00123 
00124 
00126         bool haveMassDelta() const;
00127 
00129         std::string getMassDelta() const;
00130 
00132         void setMassDelta(const char* value);
00133 
00135         void dropMassDelta();
00136 
00138         std::string getMassDeltaSchemaType() const;
00139 
00140 
00142         bool haveMassDeltaUnit() const;
00143 
00145         std::string getMassDeltaUnit() const;
00146 
00148         void setMassDeltaUnit(const char* value);
00149 
00151         void dropMassDeltaUnit();
00152 
00154         std::string getMassDeltaUnitSchemaType() const;
00155 
00156 
00158         bool haveElutionTimeDelta() const;
00159 
00161         std::string getElutionTimeDelta() const;
00162 
00164         void setElutionTimeDelta(const char* value);
00165 
00167         void dropElutionTimeDelta();
00168 
00170         std::string getElutionTimeDeltaSchemaType() const;
00171 
00172 
00174         bool haveElutionTimeDeltaUnit() const;
00175 
00177         std::string getElutionTimeDeltaUnit() const;
00178 
00180         void setElutionTimeDeltaUnit(const char* value);
00181 
00183         void dropElutionTimeDeltaUnit();
00184 
00186         std::string getElutionTimeDeltaUnitSchemaType() const;
00187 
00188 
00190         bool haveElutionProfileCorrelationThreshold() const;
00191 
00193         std::string getElutionProfileCorrelationThreshold() const;
00194 
00196         void setElutionProfileCorrelationThreshold(const char* value);
00197 
00199         void dropElutionProfileCorrelationThreshold();
00200 
00202         std::string getElutionProfileCorrelationThresholdSchemaType() const;
00203 
00204 
00206         bool haveProcessingOptions() const;
00207 
00209         std::string getProcessingOptions() const;
00210 
00212         void setProcessingOptions(const std::string value);
00213 
00215         void dropProcessingOptions();
00216 
00218         std::string getProcessingOptionsSchemaType() const;
00219 
00220 
00222         bool havePrecursorRange() const;
00223 
00225         std::string getPrecursorRange() const;
00226 
00228         void setPrecursorRange(const char* value);
00229 
00231         void dropPrecursorRange();
00232 
00234         std::string getPrecursorRangeSchemaType() const;
00235 
00236 
00238         bool haveMatchedRho() const;
00239 
00241         std::string getMatchedRho() const;
00242 
00244         void setMatchedRho(const char * value);
00245 
00247         void dropMatchedRho();
00248 
00250         std::string getMatchedRhoSchemaType() const;
00251 
00252 
00254         bool haveXicThreshold() const;
00255 
00257         std::string getXicThreshold() const;
00258 
00260         void setXicThreshold(const char * value);
00261 
00263         void dropXicThreshold();
00264 
00266         std::string getXicThresholdSchemaType() const;
00267 
00268 
00270         bool haveXicMaxWidth() const;
00271 
00273         int getXicMaxWidth() const;
00274 
00276         void setXicMaxWidth(int value);
00277 
00279         void dropXicMaxWidth();
00280 
00282         std::string getXicMaxWidthSchemaType() const;
00283 
00284 
00286         bool haveXicSmoothing() const;
00287 
00289         int getXicSmoothing() const;
00290 
00292         void setXicSmoothing(int value);
00293 
00295         void dropXicSmoothing();
00296 
00298         std::string getXicSmoothingSchemaType() const;
00299 
00300 
00302         bool haveAllChargeStates() const;
00303 
00305         bool isAllChargeStates() const;
00306 
00308         void setAllChargeStates(const bool value);
00309 
00311         void dropAllChargeStates();
00312 
00314         std::string getAllChargeStatesSchemaType() const;
00315 
00316 
00318         bool haveSimpleRatio() const;
00319 
00321         bool isSimpleRatio() const;
00322 
00324         void setSimpleRatio(const bool value);
00325 
00327         void dropSimpleRatio();
00328 
00330         std::string getSimpleRatioSchemaType() const;
00331 
00332 
00334         bool haveAllChargeStatesThreshold() const;
00335 
00337         std::string getAllChargeStatesThreshold() const;
00338 
00340         void setAllChargeStatesThreshold(const char * value);
00341 
00343         void dropAllChargeStatesThreshold();
00344 
00346         std::string getAllChargeStatesThresholdSchemaType() const;
00347 
00348 
00350         bool haveAllowElutionShift() const;
00351 
00353         bool isAllowElutionShift() const;
00354 
00356         void setAllowElutionShift(const bool value);
00357 
00359         void dropAllowElutionShift();
00360 
00362         std::string getAllowElutionShiftSchemaType() const;
00363 
00364     private:
00365         msparser_internal::ms_quant_integration_impl *m_pImpl;
00366     }; // class ms_quant_integration
00367  // end of config_group
00369 
00370 } // namespace matrix_science
00371 
00372 #endif // MS_QUANT_INTEGRATION_HPP
00373 
00374 /*------------------------------- End of File -------------------------------*/
00375 
Copyright © 2016 Matrix Science Ltd.  All Rights Reserved. Generated on Fri Jun 2 2017 01:44:51