entity_iterator.hpp

// Copyright (C) 2011-2012 by the BEM++ Authors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

#ifndef bempp_entity_iterator_hpp
#define bempp_entity_iterator_hpp

#include "../common/common.hpp"

#include "entity_pointer.hpp"
#include <memory>

namespace Bempp
{

template<int codim> class Entity;
template<int codim>
class EntityIterator: public EntityPointer<codim>
{
protected: /* Can't be changed to private, derived classes use it */
    bool m_finished;
public:
    virtual void next() = 0;

    bool finished() const {
        return m_finished;
    }

    // virtual void reset() = 0; // Would such a method be useful?

    // This redeclaration appears so that the docstring can be changed wrt. to the base class.
    virtual const Entity<codim>& entity() const = 0;

    virtual std::auto_ptr<EntityPointer<codim> > frozen() const = 0;
};

} // namespace Bempp

#endif