Matrix Science header

ms_umod_aminoacid.hpp

00001 /*
00002 ##############################################################################
00003 # file: ms_umod_aminoacid.hpp                                                #
00004 # 'msparser' toolkit                                                         #
00005 # Represents 'amino acid' object from unimod.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_umod_aminoacid.hpp,v $
00012  * @(#)$Revision: 1.8 $
00013  * @(#)$Date: 2010/09/06 16:18:57 $
00014 ##############################################################################
00015  */
00016 
00017 #ifndef MS_UMOD_AMINOACID_HPP
00018 #define MS_UMOD_AMINOACID_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_umod_xmlloader;
00042 }
00043 
00044 namespace matrix_science {
00045 
00046     class ms_umod_elemref; // forward declaration
00047     class ms_xml_schema; // forward declaration
00048 
00054 
00055     class MS_MASCOTRESFILE_API ms_umod_aminoacid: public ms_xml_IValidatable
00056     {
00057         friend class msparser_internal::ms_umod_xmlloader;
00058         friend class ms_umod_configfile;
00059 
00060     public:
00062         ms_umod_aminoacid();
00063 
00065         ms_umod_aminoacid(const ms_umod_aminoacid& src);
00066 
00068         virtual ~ms_umod_aminoacid();
00069 
00071         void defaultValues();
00072 
00074         void copyFrom(const ms_umod_aminoacid* right);
00075 
00076 #ifndef SWIG
00077 
00078         ms_umod_aminoacid& operator=(const ms_umod_aminoacid& right);
00079 #endif
00080 
00081         virtual std::string getSchemaType() const;
00082 
00084         virtual std::string validateShallow(const ms_xml_schema *pSchemaFileObj) const;
00085 
00087         virtual std::string validateDeep(const ms_xml_schema *pSchemaFileObj) const;
00088 
00089 
00091         int getNumberOfElemRefs() const;
00092 
00094         void clearElemRefs();
00095 
00097         void appendElemRef(const ms_umod_elemref *elemref);
00098 
00100         const ms_umod_elemref* getElemRef(const int idx) const;
00101 
00103         bool updateElemRef(const int idx, const ms_umod_elemref *elemref);
00104 
00106         bool deleteElemRef(const int idx);
00107 
00109         std::string getElemRefSchemaType() const;
00110 
00111 
00113         bool haveTitle() const;
00114 
00116         std::string getTitle() const;
00117 
00119         void setTitle(const char* value);
00120 
00122         void dropTitle();
00123 
00125         std::string getTitleSchemaType() const;
00126 
00127 
00129         bool haveThreeLetter() const;
00130 
00132         std::string getThreeLetter() const;
00133 
00135         void setThreeLetter(const char* value);
00136 
00138         void dropThreeLetter();
00139 
00141         std::string getThreeLetterSchemaType() const;
00142 
00143 
00145         bool haveFullName() const;
00146 
00148         std::string getFullName() const;
00149 
00151         void setFullName(const char* value);
00152 
00154         void dropFullName();
00155 
00157         std::string getFullNameSchemaType() const;
00158 
00159 
00161         bool haveAvgeMass() const;
00162 
00164         double getAvgeMass() const;
00165 
00167         void setAvgeMass(const double value);
00168 
00170         void dropAvgeMass();
00171 
00173         std::string getAvgeMassSchemaType() const;
00174 
00175 
00177         bool haveMonoMass() const;
00178 
00180         double getMonoMass() const;
00181 
00183         void setMonoMass(const double value);
00184 
00186         void dropMonoMass();
00187 
00189         std::string getMonoMassSchemaType() const;
00190 
00191     private:
00192 
00193         typedef std::vector< ms_umod_elemref* > elemref_vector;
00194         elemref_vector _elemRefs;
00195 
00196         std::string _title;
00197         bool _title_set;
00198 
00199         std::string _threeLetter;
00200         bool _threeLetter_set;
00201 
00202         std::string _fullName;
00203         bool _fullName_set;
00204 
00205         double _avgeMass;
00206         bool _avgeMass_set;
00207 
00208         double _monoMass;
00209         bool _monoMass_set;
00210     }; // class ms_umod_aminoacid
00211  // end of config_group
00213 
00214 } // namespace matrix_science
00215 
00216 #endif // MS_UMOD_AMINOACID_HPP
00217 
00218 /*------------------------------- End of File -------------------------------*/
Copyright © 2016 Matrix Science Ltd.  All Rights Reserved. Generated on Fri Jun 2 2017 01:44:51