UniverseUtil::PythonUnitIter Class Reference

#include <universe_util.h>

Inheritance diagram for UniverseUtil::PythonUnitIter:

Public Member Functions
	PythonUnitIter ()
	PythonUnitIter (const UnitCollection::UnitIterator &t)
	~PythonUnitIter ()
Unit *	current ()
void	advance ()
void	advanceSignificant ()
void	advanceInsignificant ()
void	advancePlanet ()
void	advanceJumppoint ()
void	advanceN (int)
void	advanceNSignificant (int n)
void	advanceNInsignificant (int n)
void	advanceNPlanet (int n)
void	advanceNJumppoint (int n)
void	preinsert (Unit *unit)
bool	isDone ()
bool	notDone ()
void	remove ()
class Unit *	next ()
Public Member Functions inherited from UnitCollection::UnitIterator
	UnitIterator ()
	UnitIterator (const UnitIterator &)
	UnitIterator (UnitCollection *)
virtual	~UnitIterator ()
bool	isDone ()
bool	notDone ()
void	remove ()
void	moveBefore (UnitCollection &)
void	preinsert (class Unit *)
void	postinsert (class Unit *unit)
void	advance ()
Unit *	next ()
UnitIterator &	operator= (const UnitIterator &)
const UnitIterator	operator++ (int)
const UnitIterator &	operator++ ()
Unit *	operator* ()
	UnitIterator ()
	UnitIterator (UnitListNode *start)
	Creates this unit iterator. More...
	UnitIterator (const UnitIterator &orig)
UnitIterator &	operator= (const UnitIterator &orig)
	~UnitIterator ()
bool	isDone () const
bool	notDone () const
void	remove ()
	removes something after pos. eg the first valid unit. or current() More...
void	moveBefore (UnitCollection &otherList)
void	preinsert (Unit *unit)
	inserts in front of current More...
void	postinsert (Unit *unit)
	inserts after current More...
Unit *	current ()
	returns the unit pos is pointing at or NULL if all dead or end of list. More...
Unit *	next ()
	advances the counter More...
void	advance ()
Unit *	operator++ (int)
Unit *	operator++ ()
Unit *	operator* ()

Additional Inherited Members
Protected Attributes inherited from UnitCollection::UnitIterator
UnitCollection *	col
std::list< class Unit * >::iterator	it

Detailed Description

Definition at line 19 of file universe_util.h.

Constructor & Destructor Documentation

UniverseUtil::PythonUnitIter::PythonUnitIter ( )

inline

Definition at line 21 of file universe_util.h.

: PythonUnitIter() : UnitIterator() {}

UniverseUtil::PythonUnitIter::PythonUnitIter ( const UnitCollection::UnitIterator &  t)

inline

Definition at line 23 of file universe_util.h.

: UnitIterator( t ) {}

UniverseUtil::PythonUnitIter::~PythonUnitIter ( )

inline

Definition at line 24 of file universe_util.h.

{}

Member Function Documentation

void UniverseUtil::PythonUnitIter::advance ( )

inline

Definition at line 26 of file universe_util.h.

Referenced by next().

    {
        UnitIterator::advance();
    }

void UniverseUtil::PythonUnitIter::advanceInsignificant

(

)

Definition at line 64 of file universe_util_generic.cpp.

References UnitUtil::isSignificant().

{
    advance();
    while ( notDone() && UnitUtil::isSignificant( **this ) )
        advance();
}

void UniverseUtil::PythonUnitIter::advanceJumppoint

(

)

Definition at line 78 of file universe_util_generic.cpp.

{
    advance();
    while ( notDone() && !(**this)->isJumppoint() )
        advance();
}

void UniverseUtil::PythonUnitIter::advanceN

(

int

n)

Definition at line 85 of file universe_util_generic.cpp.

{
    while (notDone() && n > 0) {
        advance();
        --n;
    }
}

void UniverseUtil::PythonUnitIter::advanceNInsignificant

(

int

n)

Definition at line 103 of file universe_util_generic.cpp.

References UnitUtil::isSignificant().

{
    if ( notDone() && UnitUtil::isSignificant( **this ) )
        advanceInsignificant();
    while ( notDone() && (n > 0) ) {
        advanceInsignificant();
        --n;
    }
}

void UniverseUtil::PythonUnitIter::advanceNJumppoint

(

int

n)

Definition at line 123 of file universe_util_generic.cpp.

{
    if ( notDone() && !(**this)->isJumppoint() )
        advanceJumppoint();
    while (notDone() && n > 0) {
        advanceJumppoint();
        --n;
    }
}

void UniverseUtil::PythonUnitIter::advanceNPlanet

(

int

n)

Definition at line 113 of file universe_util_generic.cpp.

{
    if ( notDone() && !(**this)->isPlanet() )
        advancePlanet();
    while (notDone() && n > 0) {
        advancePlanet();
        --n;
    }
}

void UniverseUtil::PythonUnitIter::advanceNSignificant

(

int

n)

Definition at line 93 of file universe_util_generic.cpp.

References UnitUtil::isSignificant().

{
    if ( notDone() && !UnitUtil::isSignificant( **this ) )
        advanceSignificant();
    while ( notDone() && (n > 0) ) {
        advanceSignificant();
        --n;
    }
}

void UniverseUtil::PythonUnitIter::advancePlanet

(

)

Definition at line 71 of file universe_util_generic.cpp.

{
    advance();
    while ( notDone() && !(**this)->isPlanet() )
        advance();
}

void UniverseUtil::PythonUnitIter::advanceSignificant

(

)

Definition at line 57 of file universe_util_generic.cpp.

References UnitUtil::isSignificant().

{
    advance();
    while ( notDone() && !UnitUtil::isSignificant( **this ) )
        advance();
}

Unit * UniverseUtil::PythonUnitIter::current

(

)

Definition at line 46 of file universe_util_generic.cpp.

References Unit::hull.

Referenced by next().

{
    Unit *ret = NULL;
    while ( (ret = **this) ) {
        if (ret->hull > 0)
            return ret;
        advance();
    }
    return ret;
}

bool UniverseUtil::PythonUnitIter::isDone ( )

inline

Definition at line 43 of file universe_util.h.

    {
        return UnitIterator::isDone();
    }

class Unit* UniverseUtil::PythonUnitIter::next ( )

inline

Definition at line 55 of file universe_util.h.

References advance(), and current().

    {
        advance();
        return current();
    }

bool UniverseUtil::PythonUnitIter::notDone ( )

inline

Definition at line 47 of file universe_util.h.

    {
        return UnitIterator::notDone();
    }

void UniverseUtil::PythonUnitIter::preinsert ( Unit *  unit)

inline

Definition at line 39 of file universe_util.h.

    {
        UnitIterator::preinsert( unit );
    }

void UniverseUtil::PythonUnitIter::remove ( )

inline

Definition at line 51 of file universe_util.h.

    {
        UnitIterator::remove();
    }

---

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

• src/universe_util.h
• src/universe_util_generic.cpp