The Gnome Chemistry Utils: crystalcleavage.h Source File

- Main Page
- Namespaces
- Classes
- Files
- Directories

# crystalcleavage.h

    00001 // -*- C++ -*-
    00002
    00003 /*
    00004  * Gnome Chemisty Utils
    00005  * crystalcleavage.h
    00006  *
    00007  * Copyright (C) 2002-2004 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 CRYSTAL_CLEAVAGE_H
    00026 #define CRYSTAL_CLEAVAGE_H
    00027
    00028 #include <libxml/parser.h>
    00029 #include <list>
    00030
    00031 namespace gcu
    00032 {
    00033
    00039 class CrystalCleavage
    00040 {
    00041 public:
    00042 /*
    00043 The default constructor.
    00044 */
    00045         CrystalCleavage ();
    00051         CrystalCleavage (CrystalCleavage& ccCleavage) ;
    00052 /*
    00053 The destructor of CrystalAtom.
    00054 */
    00055         virtual ~CrystalCleavage ();
    00056
    00060         int& Planes () {return m_nPlanes ;}
    00064         int& h () {return m_nh ;}
    00068         int& k () {return m_nk ;}
    00072         int & l () {return m_nl ;}
    00078         CrystalCleavage& operator= (CrystalCleavage& ccCleavage) ;
    00083         bool operator== (CrystalCleavage& ccCleavage) ;
    00090         xmlNodePtr Save (xmlDocPtr xml);
    00097         bool Load (xmlNodePtr node);
    00098
    00099 protected:
    00103         int m_nh;
    00107         int m_nk;
    00111         int m_nl;
    00115         int m_nPlanes ;
    00116 };
    00117
    00121 typedef std::list<CrystalCleavage*> CrystalCleavageList;
    00122
    00123 } //namespace gcu
    00124
    00125 #endif //CRYSTAL_CLEAVAGE_H