cleavage.h

Go to the documentation of this file.

// -*- C++ -*-

/*
 * Gnome Chemisty Utils
 * gcr/cleavage.h
 *
 * Copyright (C) 2002-2011 Jean Bréfort <jean.brefort@normalesup.org>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
 * USA
 */

#ifndef GCR_CLEAVAGE_H
#define GCR_CLEAVAGE_H

#include <libxml/parser.h>
#include <list>

namespace gcr
{

class Cleavage
{
public:
/*
The default constructor.
*/
        Cleavage ();
        Cleavage (Cleavage& ccCleavage) ;
/*
The destructor of Cleavage.
*/
        virtual ~Cleavage ();

        unsigned &Planes () {return m_nPlanes ;}
        int& h () {return m_nh ;}
        int& k () {return m_nk ;}
        int & l () {return m_nl ;}
        Cleavage& operator= (Cleavage& ccCleavage) ;
        bool operator== (Cleavage& ccCleavage) ;
        xmlNodePtr Save (xmlDocPtr xml) const;
        bool Load (xmlNodePtr node);

protected:
        int m_nh;
        int m_nk;
        int m_nl;
        unsigned m_nPlanes ;
};

typedef std::list<Cleavage*> CleavageList;

} //namespace gcr

#endif  //      GCR_CLEAVAGE_H