Matrix Science header

ms_quant_multiplex.hpp

00001 /*
00002 ##############################################################################
00003 # file: ms_quant_multiplex.hpp                                           #
00004 # 'msparser' toolkit                                                         #
00005 # Encapsulates normalisation-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_multiplex.hpp,v $
00012  * @(#)$Revision: 1.12 $
00013  * @(#)$Date: 2010/09/06 16:18:57 $
00014 ##############################################################################
00015  */
00016 
00017 #ifndef MS_QUANT_MULTIPLEX_HPP
00018 #define MS_QUANT_MULTIPLEX_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 // forward declarations
00037 namespace msparser_internal {
00038     class ms_quant_xmlloader;
00039 }
00040 
00041 namespace matrix_science {
00042 
00043     class ms_xml_schema; // forward declaration
00044 
00050 
00051 
00054     class MS_MASCOTRESFILE_API ms_quant_multiplex: public ms_quant_parameters
00055     {
00056         friend class msparser_internal::ms_quant_xmlloader;
00057     public:
00059         ms_quant_multiplex();
00060 
00062         ms_quant_multiplex(const ms_quant_multiplex& src);
00063 
00065         virtual ~ms_quant_multiplex();
00066 
00068         void defaultValues();
00069 
00071         void copyFrom(const ms_quant_multiplex* right);
00072 
00073 #ifndef SWIG
00074 
00075         ms_quant_multiplex& operator=(const ms_quant_multiplex& right);
00076 #endif
00077 
00078         virtual std::string getSchemaType() const;
00079 
00081         virtual std::string validateShallow(const ms_xml_schema *pSchemaFileObj) const;
00082 
00084         virtual std::string validateDeep(const ms_xml_schema *pSchemaFileObj) const;
00085 
00086 
00088         bool haveIonSeries() const;
00089 
00091         void setIonSeries(const std::string ionSeries);
00092 
00094         void dropIonSeries();
00095 
00097         std::string getIonSeriesSchemaType() const;
00098 
00100         int getNumberOfIonSeries() const;
00101 
00103         void clearIonSeries();
00104 
00106         void appendIonSeries(const std::string ionSeries);
00107 
00109         const std::string getIonSeries(const int idx=0) const;
00110 
00112         bool updateIonSeries(const int idx, const std::string ionSeries);
00113 
00115         bool deleteIonSeries(const int idx);
00116 
00118         bool haveExcludeInternalLabel() const;
00119 
00121         bool isExcludeInternalLabel() const;
00122 
00124         void setExcludeInternalLabel(const bool value);
00125 
00127         void dropExcludeInternalLabel();
00128 
00130         std::string getExcludeInternalLabelSchemaType() const;
00131 
00132 
00134         bool haveIonIntensityThreshold() const;
00135 
00137         std::string getIonIntensityThreshold() const;
00138 
00140         void setIonIntensityThreshold(const char* value);
00141 
00143         void dropIonIntensityThreshold();
00144 
00146         std::string getIonIntensityThresholdSchemaType() const;
00147 
00148 
00150         bool haveExcludeIsobaricFragments() const;
00151 
00153         bool isExcludeIsobaricFragments() const;
00154 
00156         void setExcludeIsobaricFragments(const bool value);
00157 
00159         void dropExcludeIsobaricFragments();
00160 
00162         std::string getExcludeIsobaricFragmentsSchemaType() const;
00163 
00164 
00166         bool haveMinIonPairs() const;
00167 
00169         int getMinIonPairs() const;
00170 
00172         void setMinIonPairs(const int value);
00173 
00175         void dropMinIonPairs();
00176 
00178         std::string getMinIonPairsSchemaType() const;
00179 
00180     private:
00181 
00182         typedef std::vector< std::string > string_vector;
00183         string_vector _ionSeries;
00184 
00185         bool _excludeInternalLabel;
00186         bool _excludeInternalLabel_set;
00187 
00188         std::string _ionIntensityThreshold;
00189         bool _ionIntensityThreshold_set;
00190 
00191         bool _excludeIsobaricFragments;
00192         bool _excludeIsobaricFragments_set;
00193 
00194         int _minIonPairs;
00195         bool _minIonPairs_set;
00196     }; // class ms_quant_multiplex
00197  // end of config_group
00199 
00200 } // namespace matrix_science
00201 
00202 #endif // MS_QUANT_MULTIPLEX_HPP
00203 
00204 /*------------------------------- End of File -------------------------------*/
Copyright © 2016 Matrix Science Ltd.  All Rights Reserved. Generated on Fri Jun 2 2017 01:44:51