//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
// Author: Mathieu Karamitros

// The code is developed in the framework of the ESA AO7146
//
// We would be very happy hearing from you, send us your feedback! :)
//
// In order for Geant4-DNA to be maintained and still open-source,
// article citations are crucial. 
// If you use Geant4-DNA chemistry and you publish papers about your software, 
// in addition to the general paper on Geant4-DNA:
//
// Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178
//
// we would be very happy if you could please also cite the following
// reference papers on chemistry:
//
// J. Comput. Phys. 274 (2014) 841-882
// Prog. Nucl. Sci. Tec. 2 (2011) 503-508 

#ifndef G4MOLECULEITERATOR_HH_
#define G4MOLECULEITERATOR_HH_

#include <map>
#include "globals.hh"

template<typename MOLECULE>
class G4MoleculeIterator
{
protected:
  using MAP = std::map<G4String, MOLECULE *>;
  MAP* fMap;
  G4bool fDefined;
  typename MAP::iterator fIt;

public:
  G4MoleculeIterator(MAP& _map) :
      fMap(&_map)
  {
    fDefined = false;
  }

  virtual ~G4MoleculeIterator()
  = default;

  G4MoleculeIterator(const G4MoleculeIterator& right)
  {
    fMap = right.fMap;
    fDefined = right.fDefined;
    fIt = right.fIt;
  }

  G4MoleculeIterator& operator=(const G4MoleculeIterator& right)
  {
    if (this == &right) return *this;
    fMap = right.fMap;
    fDefined = right.fDefined;
    fIt = right.fIt;
    return *this;
  }

  G4bool operator++(int)
  {
    if (!fDefined) return false;
    fIt++;
    return static_cast<G4bool>(fIt != fMap->end());
  }

  G4bool operator++()
  {
    if (!fDefined) return false;
    fIt++;
    return static_cast<G4bool>(fIt != fMap->end());
  }

  void reset()
  {
    fDefined = false;
  }

  G4bool operator()()
  {
    if (!fDefined)
    {
      fDefined = true;
      fIt = fMap->begin();
      return true;
    }
    
    fIt++;
   
    return static_cast<G4bool>(fIt != fMap->end());
  }

  const G4String& Name()
  {
    return fIt->first;
  }

  MOLECULE* value()
  {
    return fIt->second;
  }
};

#endif /* G4MOLECULEITERATOR_HH_ */