#ifndef PERIODENTAFEL_HPP_
#define PERIODENTAFEL_HPP_

/*********************************************** includes ***********************************/

// include config.h
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <iostream>
#include <map>
#include <iterator>

#include "defs.hpp"
#include "types.hpp"

/****************************************** forward declarations *****************************/

class element;

/********************************************** declarations *******************************/


/** Periodentafel is a list of all elements sorted by their atomic number.
 */
class periodentafel {
  /******* Types *********/
  private:
    typedef std::map<atomicNumber_t,element*> elementSet;
  public:
    typedef elementSet::iterator iterator;
    typedef elementSet::const_iterator const_iterator;
    typedef std::reverse_iterator<const_iterator> reverse_iterator;
  public:

    char header1[MAXSTRINGSIZE]; //!< store first header line
    char header2[MAXSTRINGSIZE]; //!< store second header line

  periodentafel();
  ~periodentafel();

  iterator AddElement(element * const pointer);
  void RemoveElement(element * const pointer);
  void CleanupPeriodtable();
  const element *FindElement(atomicNumber_t) const;
  const element *FindElement(const char * const shorthand) const;
  const element *AskElement() const;
  const element *EnterElement();

  const_iterator begin();
  const_iterator end();
  reverse_iterator rbegin();
  reverse_iterator rend();
  bool Output(std::ostream * const output) const;
  bool Checkout(std::ostream * const output, const int * const checkliste) const;
  bool LoadPeriodentafel(const char * const path);
  bool StorePeriodentafel(const char * const path) const;

  private:
    elementSet elements;
};


#endif /*PERIODENTAFEL_HPP_*/