The Gnome Chemistry Utils  0.13.7
gcu/residue.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 /*
00004  * Gnome Chemistry Utils
00005  * residue.h
00006  *
00007  * Copyright (C) 2007-2008 Jean Bréfort <jean.brefort@normalesup.org>
00008  *
00009  * This program is free software; you can redistribute it and/or
00010  * modify it under the terms of the GNU General Public License as
00011  * published by the Free Software Foundation; either version 3 of the
00012  * License, or (at your option) any later version.
00013  *
00014  * This program is distributed in the hope that it will be useful,
00015  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00017  * GNU General Public License for more details.
00018  *
00019  * You should have received a copy of the GNU General Public License
00020  * along with this program; if not, write to the Free Software
00021  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
00022  * USA
00023  */
00024 
00025 #ifndef GCU_RESIDUE_H
00026 #define GCU_RESIDUE_H
00027 
00028 #include "macros.h"
00029 #include <libxml/parser.h>
00030 #include <map>
00031 #include <set>
00032 #include <string>
00033 
00035 namespace gcu {
00036 
00037 class Application;
00038 class Residue;
00039 class Molecule;
00040 class Document;
00041 
00045 typedef struct {
00051         Residue *res;
00055         bool ambiguous;
00056 } SymbolResidue;
00057 
00058 typedef std::map<std::string, SymbolResidue>::iterator ResidueIterator;
00059 
00067 class Residue
00068 {
00069 public:
00073         Residue ();
00080         Residue (char const *name, Document *doc = NULL);
00084         virtual ~Residue ();
00085 
00099         std::map<int,int> const &GetRawFormula () const {return m_Raw;}
00106         std::map<std::string, bool> const &GetSymbols () const {return m_Symbols;}
00111         std::map<std::string, std::string> const &GetNames () const {return m_Names;}
00115         void SetName (char const *name);
00121         void AddSymbol (char const *symbol);
00127         void RemoveSymbol (char const *symbol);
00134         virtual void Load (xmlNodePtr node, Application *app);
00142         static Residue const *GetResidue (char const *symbol, bool *ambiguous = NULL);
00148         static Residue const *GetResiduebyName (char const *name);
00157         static std::string const *GetFirstResidueSymbol (ResidueIterator &i);
00167         static std::string const *GetNextResidueSymbol (ResidueIterator &i);
00172         virtual bool operator== (G_GNUC_UNUSED Molecule const &mol) const {return false;}
00173 
00174 public:
00179         static unsigned MaxSymbolLength;
00180 
00181 private:
00182         std::map<int,int> m_Raw;
00183         std::map<std::string, bool> m_Symbols; // boolean is true if the symbol is ambiguous
00184         std::map<std::string, std::string> m_Names;
00185 
00189 GCU_RO_PROP (char const *, Name)
00204 GCU_PROP (bool, Generic)
00209 GCU_PROT_POINTER_PROP (Document, Document);
00214 GCU_PROT_POINTER_PROP (Molecule, Molecule);
00219 GCU_RO_PROP (Document *, Owner)
00220 };
00221 
00222 }       //      namespace gcu
00223 
00224 #endif  //      GCU_RESIDUE_H