The Gnome Chemistry Utils 0.13.3
cleavage.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 /* 
00004  * Gnome Chemisty Utils
00005  * gcr/cleavage.h 
00006  *
00007  * Copyright (C) 2002-2010 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 2 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 GCR_CLEAVAGE_H
00026 #define GCR_CLEAVAGE_H
00027 
00028 #include <libxml/parser.h>
00029 #include <list>
00030 
00032 namespace gcr
00033 {
00034 
00040 class Cleavage
00041 {
00042 public:
00043 /*
00044 The default constructor.
00045 */
00046         Cleavage ();
00052         Cleavage (Cleavage& ccCleavage) ;
00053 /*
00054 The destructor of Cleavage.
00055 */
00056         virtual ~Cleavage ();
00057 
00061         int& Planes () {return m_nPlanes ;}
00065         int& h () {return m_nh ;}
00069         int& k () {return m_nk ;}
00073         int & l () {return m_nl ;}
00079         Cleavage& operator= (Cleavage& ccCleavage) ;
00084         bool operator== (Cleavage& ccCleavage) ;
00091         xmlNodePtr Save (xmlDocPtr xml) const;
00098         bool Load (xmlNodePtr node);
00099         
00100 protected:
00104         int m_nh;
00108         int m_nk;
00112         int m_nl;
00116         int m_nPlanes ;
00117 };
00118 
00122 typedef std::list<Cleavage*> CleavageList;
00123         
00124 } //namespace gcr
00125 
00126 #endif  //      GCR_CLEAVAGE_H