Matrix Science header

ms_quant_protocol.hpp

00001 /*
00002 ##############################################################################
00003 # file: ms_quant_protocol.hpp                                                #
00004 # 'msparser' toolkit                                                         #
00005 # Encapsulates protocol-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_protocol.hpp,v $
00012  * @(#)$Revision: 1.11 $
00013  * @(#)$Date: 2010/09/06 16:18:57 $
00014 ##############################################################################
00015  */
00016 
00017 #ifndef MS_QUANT_PROTOCOL_HPP
00018 #define MS_QUANT_PROTOCOL_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 
00038 // forward declarations
00039 namespace msparser_internal {
00040     class ms_quant_xmlloader;
00041     class ms_quant_protocol_impl;
00042     class ms_quant_method_impl;
00043 }
00044 
00045 namespace matrix_science {
00046 
00047      // forward declarations
00048     class ms_quant_parameters;
00049     class ms_quant_reporter;
00050     class ms_quant_precursor;
00051     class ms_quant_replicate;
00052     class ms_quant_average;
00053     class ms_quant_multiplex;
00054     class ms_xml_schema;
00055 
00061 
00062 
00069     class MS_MASCOTRESFILE_API ms_quant_protocol: public ms_xml_IValidatable
00070     {
00071         friend class msparser_internal::ms_quant_xmlloader;
00072         friend class msparser_internal::ms_quant_method_impl;
00073     public:
00075         ms_quant_protocol();
00076 
00078         ms_quant_protocol(const ms_quant_protocol& src);
00079 
00081         virtual ~ms_quant_protocol();
00082 
00084         void defaultValues();
00085 
00087         void copyFrom(const ms_quant_protocol* right);
00088 
00089 #ifndef SWIG
00090 
00091         ms_quant_protocol& operator=(const ms_quant_protocol& right);
00092 #endif
00093 
00094         virtual std::string getSchemaType() const;
00095 
00097         virtual std::string validateShallow(const ms_xml_schema *pSchemaFileObj) const;
00098 
00100         virtual std::string validateDeep(const ms_xml_schema *pSchemaFileObj) const;
00101 
00102 
00104         std::string getType() const;
00105 
00107         void setNull();
00108 
00109 
00111         const ms_quant_reporter* getReporter() const;
00112 
00114         void setReporter(const ms_quant_reporter* reporter);
00115 
00117         std::string getReporterSchemaType() const;
00118 
00119 
00121         const ms_quant_precursor* getPrecursor() const;
00122 
00124         void setPrecursor(const ms_quant_precursor* precursor);
00125 
00127         std::string getPrecursorSchemaType() const;
00128 
00129 
00131         const ms_quant_multiplex* getMultiplex() const;
00132 
00134         void setMultiplex(const ms_quant_multiplex* multiplex);
00135 
00137         std::string getMultiplexSchemaType() const;
00138 
00139 
00141         const ms_quant_replicate* getReplicate() const;
00142 
00144         void setReplicate(const ms_quant_replicate* replicate);
00145 
00147         std::string getReplicateSchemaType() const;
00148 
00149 
00151         const ms_quant_average* getAverage() const;
00152 
00154         void setAverage(const ms_quant_average* average);
00155 
00157         std::string getAverageSchemaType() const;
00158 
00159     private:
00160 
00161         msparser_internal::ms_quant_protocol_impl * m_pImpl;
00162 
00163     }; // class ms_quant_protocol
00164  // end of config_group
00166 
00167 } // namespace matrix_science
00168 
00169 #endif // MS_QUANT_PROTOCOL_HPP
00170 
00171 /*------------------------------- End of File -------------------------------*/
Copyright © 2016 Matrix Science Ltd.  All Rights Reserved. Generated on Fri Jun 2 2017 01:44:51