Iterator.h

Go to the documentation of this file.

/*
 * This file is a part of the Biology project by eons LLC.
 * Biology (aka Develop Biology) is a framework for approaching software
 * development from a natural sciences perspective.
 *
 * Copyright (C) 2022 Séon O'Shannon & eons LLC
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "bio/physical/common/Types.h"
#include "bio/physical/macros/Macros.h"
 
namespace bio {
 
class Container;
 
class Iterator
{
public:
 
    Iterator(
        const Container* container,
        const Index index = InvalidIndex());
 
    virtual ~Iterator();
 
    Index GetIndex() const;
 
    bool MoveTo(const Index index);
 
    virtual bool IsAtBeginning() const;
 
    virtual bool IsAtEnd() const;
 
    virtual Iterator* Increment();
 
    virtual Iterator* Decrement();
 
    virtual ByteStream operator*();
 
    virtual const ByteStream operator*() const;
 
protected:
    mutable Container* m_container;
    Index m_index;
}; //Iterator class.
 
} //bio namespace