inet::physicallayer::ConstMappingIteratorWrapper Class Reference

Wraps an ConstMappingIterator into a MappingIterator interface. More...

#include <MappingUtils.h>

Inheritance diagram for inet::physicallayer::ConstMappingIteratorWrapper:

Public Member Functions
	ConstMappingIteratorWrapper (ConstMappingIterator *it)
virtual	~ConstMappingIteratorWrapper ()
virtual void	setValue (argument_value_cref_t) override
	Changes the value of the Mapping at the current position. More...
virtual const Argument &	getNextPosition () const override
	Returns the position the next call to "next()" of this Iterator would iterate to. More...
virtual void	jumpTo (const Argument &pos) override
	Lets the iterator point to the passed position. More...
virtual void	jumpToBegin () override
	Lets the iterator point to the begin of the mapping. More...
virtual void	iterateTo (const Argument &pos) override
	Iterates to the specified position. More...
virtual void	next () override
	Iterates to the next position of the Mapping. More...
virtual bool	inRange () const override
	Returns true if the current position of the iterator is in range of the function. More...
virtual bool	hasNext () const override
	Returns true if the iterator has a next value it can iterate to on a call to "next()". More...
virtual const Argument &	getPosition () const override
	Returns the current position of the iterator. More...
virtual argument_value_t	getValue () const override
	Returns the value of the Mapping at the current position. More...
Public Member Functions inherited from inet::physicallayer::MappingIterator
	MappingIterator ()
virtual	~MappingIterator ()
Public Member Functions inherited from inet::physicallayer::ConstMappingIterator
	ConstMappingIterator ()
virtual	~ConstMappingIterator ()
	ConstMappingIterator (const ConstMappingIterator &)
	Copy constructor. More...
ConstMappingIterator &	operator= (const ConstMappingIterator &)
	ConstMappingIterator assignment operator. More...
void	swap (ConstMappingIterator &)
	Swaps data with another ConstMappingIterator. More...

Protected Attributes
ConstMappingIterator *const	iterator

Private Member Functions
	ConstMappingIteratorWrapper (const ConstMappingIteratorWrapper &)
	Copy constructor is not allowed. More...
ConstMappingIteratorWrapper &	operator= (const ConstMappingIteratorWrapper &)
	Assignment operator is not allowed. More...

Additional Inherited Members
Public Types inherited from inet::physicallayer::ConstMappingIterator
typedef Argument::mapped_type	argument_value_t
typedef Argument::mapped_type_cref	argument_value_cref_t

Detailed Description

Wraps an ConstMappingIterator into a MappingIterator interface.

Assumes that "setValue()" of the MappingIterator interface will never be called.

Author

Karl Wessel

Constructor & Destructor Documentation

inet::physicallayer::ConstMappingIteratorWrapper::ConstMappingIteratorWrapper ( const ConstMappingIteratorWrapper &  )

private

Copy constructor is not allowed.

inet::physicallayer::ConstMappingIteratorWrapper::ConstMappingIteratorWrapper ( ConstMappingIterator *  it )

inline

                                                          :
        MappingIterator(), iterator(it) {}

virtual inet::physicallayer::ConstMappingIteratorWrapper::~ConstMappingIteratorWrapper ( )

inlinevirtual

    {
        if (iterator)
            delete iterator;
    }

Member Function Documentation

virtual const Argument& inet::physicallayer::ConstMappingIteratorWrapper::getNextPosition ( ) const

inlineoverridevirtual

Returns the position the next call to "next()" of this Iterator would iterate to.

Implements inet::physicallayer::ConstMappingIterator.

{ return iterator->getNextPosition(); }

virtual const Argument& inet::physicallayer::ConstMappingIteratorWrapper::getPosition ( ) const

inlineoverridevirtual

Returns the current position of the iterator.

Implements inet::physicallayer::ConstMappingIterator.

{ return iterator->getPosition(); }

virtual argument_value_t inet::physicallayer::ConstMappingIteratorWrapper::getValue ( ) const

inlineoverridevirtual

Returns the value of the Mapping at the current position.

The complexity of this method should be constant for every implementation.

Implements inet::physicallayer::ConstMappingIterator.

{ return iterator->getValue(); }

virtual bool inet::physicallayer::ConstMappingIteratorWrapper::hasNext ( ) const

inlineoverridevirtual

Returns true if the iterator has a next value it can iterate to on a call to "next()".

Implements inet::physicallayer::ConstMappingIterator.

{ return iterator->hasNext(); }

virtual bool inet::physicallayer::ConstMappingIteratorWrapper::inRange ( ) const

inlineoverridevirtual

Returns true if the current position of the iterator is in range of the function.

This method should be used as end-condition when iterating over the function with the "next()" method.

Implements inet::physicallayer::ConstMappingIterator.

{ return iterator->inRange(); }

virtual void inet::physicallayer::ConstMappingIteratorWrapper::iterateTo ( const Argument &  pos )

inlineoverridevirtual

Iterates to the specified position.

This method should be used if the new position is near the current position. Furthermore the new position has to be compared bigger than the old position.

Implements inet::physicallayer::ConstMappingIterator.

{ iterator->iterateTo(pos); }

virtual void inet::physicallayer::ConstMappingIteratorWrapper::jumpTo ( const Argument &  pos )

inlineoverridevirtual

Lets the iterator point to the passed position.

The passed new position can be at arbitrary places.

Implements inet::physicallayer::ConstMappingIterator.

{ iterator->jumpTo(pos); }

virtual void inet::physicallayer::ConstMappingIteratorWrapper::jumpToBegin ( )

inlineoverridevirtual

Lets the iterator point to the begin of the mapping.

The beginning of the mapping depends on the implementation. With an implementation based on a number of key-entries, this could be the key entry with the smallest position (see class Argument for ordering of positions).

Implements inet::physicallayer::ConstMappingIterator.

{ iterator->jumpToBegin(); }

virtual void inet::physicallayer::ConstMappingIteratorWrapper::next ( )

inlineoverridevirtual

Iterates to the next position of the Mapping.

The next position depends on the implementation of the Mapping. With an implementation based on a number of key-entries this probably would be the next bigger key-entry.

Implements inet::physicallayer::ConstMappingIterator.

{ iterator->next(); }

ConstMappingIteratorWrapper& inet::physicallayer::ConstMappingIteratorWrapper::operator= ( const ConstMappingIteratorWrapper &  )

private

Assignment operator is not allowed.

virtual void inet::physicallayer::ConstMappingIteratorWrapper::setValue ( argument_value_cref_t  value )

inlineoverridevirtual

Changes the value of the Mapping at the current position.

Implementations of this method should provide constant complexity.

Implements inet::physicallayer::MappingIterator.

{ assert(false); }

Member Data Documentation

ConstMappingIterator* const inet::physicallayer::ConstMappingIteratorWrapper::iterator

protected

---

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

• MappingUtils.h