bio::Iterator Class Reference

#include <Iterator.h>

Collaboration diagram for bio::Iterator:

Public Member Functions
	Iterator (const Container *container, const Index index=InvalidIndex())
virtual	~Iterator ()
virtual Iterator *	Decrement ()
Index	GetIndex () const
virtual Iterator *	Increment ()
virtual bool	IsAtBeginning () const
virtual bool	IsAtEnd () const
bool	MoveTo (const Index index)
virtual ByteStream	operator* ()
virtual const ByteStream	operator* () const

Protected Attributes
Container *	m_container
Index	m_index

Detailed Description

An Iterator is the preferred means of accessing the elements stored in an Container. Please use increment and decrement operators to move through these elements. While untested, it is likely that starting at the end and decrementing will be faster than starting at the beginning and incrementing, due to removing the overhead of having to keep track of where the end is.

NOTE: There are no checks to guard against being given a bad Container*. These have been neglected to increase performance.

Definition at line 38 of file Iterator.h.

Constructor & Destructor Documentation

Iterator()

bio::Iterator::Iterator	(	const Container *	container,
		const Index	index = InvalidIndex()
	)

Constructor is only built with a const Container*. We cast away the cv and keep only the mutable pointer. This is done in order to avoid having a separate class for const access (as is in the standard library).

Parameters

container
index

Definition at line 27 of file Iterator.cpp.

    :
    m_container(const_cast< Container* >(container)),
    m_index(index)
{
 
}

~Iterator()

bio::Iterator::~Iterator ( )

virtual

Definition at line 38 of file Iterator.cpp.

{
 
}

Member Function Documentation

Decrement()

Iterator * bio::Iterator::Decrement ( )

virtual

Move *this down a Index.

Returns

*this following decrementing.

Definition at line 82 of file Iterator.cpp.

{
    if (!m_index)
    {
        return this;
    }
    while (m_container->IsFree(--m_index) && !IsAtBeginning())
    {
        continue; //avoid re-referencing m_index; see condition.
    }
    return this;
}

References IsAtBeginning(), bio::Container::IsFree(), m_container, and m_index.

Referenced by bio::SmartIterator::operator--().

GetIndex()

Index bio::Iterator::GetIndex

(

)

const

Returns

the index *this is currently at.

Definition at line 43 of file Iterator.cpp.

{
    return m_index;
}

References m_index.

Referenced by bio::Container::Clear(), bio::SmartIterator::GetIndex(), bio::Container::SeekTo(), bio::physical::Line::SeekToId(), and bio::physical::Line::SeekToName().

Increment()

Iterator * bio::Iterator::Increment ( )

virtual

Move *this up a Index

Returns

*this after incrementing.

Definition at line 68 of file Iterator.cpp.

{
    if (m_index >= m_container->GetAllocatedSize())
    {
        m_index = m_container->GetAllocatedSize();
        return this;
    }
    while (m_container->IsFree(++m_index) && !IsAtEnd())
    {
        continue; //avoid re-referencing m_index; see condition.
    }
    return this;
}

References bio::Container::GetAllocatedSize(), IsAtEnd(), bio::Container::IsFree(), m_container, and m_index.

Referenced by bio::SmartIterator::operator++().

IsAtBeginning()

bool bio::Iterator::IsAtBeginning ( ) const

virtual

Returns

whether or not *this has reached the beginning of its Arrangement.

Definition at line 58 of file Iterator.cpp.

{
    return !m_index;
}

References m_index.

Referenced by bio::Container::Clear(), Decrement(), bio::Container::Import(), bio::SmartIterator::IsAtBeginning(), bio::Container::SeekTo(), bio::physical::Line::SeekToId(), and bio::physical::Line::SeekToName().

IsAtEnd()

bool bio::Iterator::IsAtEnd ( ) const

virtual

Returns

whether or not *this has reached the end of its Arrangement.

Definition at line 63 of file Iterator.cpp.

{
    return m_index == m_container->GetAllocatedSize();
}

References bio::Container::GetAllocatedSize(), m_container, and m_index.

Referenced by Increment(), and bio::SmartIterator::IsAtEnd().

MoveTo()

bool bio::Iterator::MoveTo

(

const Index

index

)

Make *this point somewhere else;

Parameters

index

Returns

whether or not *this was moved.

Definition at line 48 of file Iterator.cpp.

{
    if (m_container->IsAllocated(index))
    {
        m_index = index;
        return true;
    }
    return false;
}

References bio::Container::IsAllocated(), m_container, and m_index.

Referenced by bio::Container::Clear(), bio::SmartIterator::MoveTo(), bio::Container::SeekTo(), bio::physical::Line::SeekToId(), and bio::physical::Line::SeekToName().

operator*() [1/2]

ByteStream bio::Iterator::operator* ( )

virtual

Dereferencing gives the datum *this is currently pointing to.

Returns

a ByteStream containing the datum requested.

Definition at line 95 of file Iterator.cpp.

{
    return m_container->Access(m_index);
}

References bio::Container::Access(), m_container, and m_index.

operator*() [2/2]

const ByteStream bio::Iterator::operator* ( ) const

virtual

Dereferencing gives the datum *this is currently pointing to.

Returns

a ByteStream containing the datum requested.

Definition at line 100 of file Iterator.cpp.

{
    return m_container->Access(m_index);
}

References bio::Container::Access(), m_container, and m_index.

Member Data Documentation

m_container

Container* bio::Iterator::m_container

mutableprotected

Definition at line 105 of file Iterator.h.

Referenced by Decrement(), Increment(), IsAtEnd(), MoveTo(), and operator*().

m_index

Index bio::Iterator::m_index

protected

Definition at line 106 of file Iterator.h.

Referenced by Decrement(), GetIndex(), Increment(), IsAtBeginning(), IsAtEnd(), MoveTo(), and operator*().

---

The documentation for this class was generated from the following files:

• /home/eons/git/biology/lib_bio/inc/bio/common/container/Iterator.h
• /home/eons/git/biology/lib_bio/src/common/container/Iterator.cpp