UnitCollection Class Reference

#include <collection.h>

Classes
class	ConstFastIterator
class	ConstIterator
class	FastIterator
class	UnitIterator

Public Types
typedef ConstIterator	ConstFastIterator
typedef UnitIterator	FastIterator

Public Member Functions
	UnitCollection ()
	UnitCollection (const UnitCollection &)
	~UnitCollection ()
UnitIterator	createIterator ()
FastIterator	fastIterator ()
ConstIterator	constIterator () const
ConstFastIterator	constFastIterator () const
void	insert_unique (Unit *)
bool	empty () const
void	prepend (Unit *)
void	prepend (UnitIterator *)
void	append (class Unit *)
void	append (UnitIterator *)
void	insert (std::list< Unit * >::iterator &, Unit *)
void	clear ()
bool	contains (const class Unit *) const
void	erase (std::list< class Unit * >::iterator &)
bool	remove (const class Unit *)
const int	size () const
Unit *	back ()
Unit *	front ()
	UnitCollection ()
	Initislizes the first unit and then calls init;. More...
	~UnitCollection ()
	destroys the list permanently More...
bool	empty () const
UnitIterator	createIterator ()
ConstIterator	constIterator () const
FastIterator	fastIterator ()
ConstFastIterator	constFastIterator () const
void	insert_unique (Unit *un)
void	prepend (Unit *unit)
void	prepend (UnitListNode *unitlistnode)
void	prepend (UnitIterator *iter)
void	append (Unit *unit)
void	append (UnitIterator *iter)
void	clear ()
bool	contains (const Unit *unit) const
bool	remove (const Unit *unit)
void	cleanup ()
Unit *	front ()
const Unit *	front () const
	UnitCollection (const UnitCollection &c)
const UnitCollection &	operator= (const UnitCollection &c)

Static Public Member Functions
static void	FreeUnusedNodes ()
static void *	PushUnusedNode (UnitListNode *node)

Friends
class	UnitIterator
class	ConstIterator

Detailed Description

Definition at line 29 of file collection.h.

Member Typedef Documentation

typedef ConstIterator UnitCollection::ConstFastIterator

Definition at line 143 of file collection.h.

typedef UnitIterator UnitCollection::FastIterator

Definition at line 144 of file collection.h.

Constructor & Destructor Documentation

UnitCollection::UnitCollection

(

)

Definition at line 176 of file collection.cpp.

{
    activeIters.reserve( 20 );
}

UnitCollection::UnitCollection

(

const UnitCollection &

uc)

Definition at line 181 of file collection.cpp.

References append().

{
    list< Unit* >::const_iterator in = uc.u.begin();
    while ( in != uc.u.end() ) {
        append( *in );
        ++in;
    }
}

UnitCollection::~UnitCollection ( )

inline

Definition at line 148 of file collection.h.

    {
         destr();
    }

UnitCollection::UnitCollection ( )

inline

Initislizes the first unit and then calls init;.

Definition at line 47 of file oldcollection.h.

    {
        init();
    }

UnitCollection::~UnitCollection ( )

inline

destroys the list permanently

Definition at line 52 of file oldcollection.h.

    {
        destr();
    }

UnitCollection::UnitCollection

(

const UnitCollection &

c)

Member Function Documentation

void UnitCollection::append

(

class Unit *

un)

Definition at line 222 of file collection.cpp.

References Unit::Ref().

Referenced by Planet::PlanetIterator::advance(), Planet::PlanetIterator::PlanetIterator(), and UnitCollection().

{
    if (un) {
        un->Ref();
        u.push_back( un );
    }
}

void UnitCollection::append

(

UnitIterator *

it)

Definition at line 230 of file collection.cpp.

References UnitCollection::UnitIterator::advance(), and Unit::Ref().

{
    if (!it) return;
    Unit *tmp = NULL;
    while ( (tmp = **it) ) {
        tmp->Ref();
        u.push_back( tmp );
        it->advance();
    }
}

void UnitCollection::append

(

Unit *

unit)

void UnitCollection::append

(

UnitIterator *

iter)

Unit* UnitCollection::back ( )

inline

Definition at line 219 of file collection.h.

    {
        for (std::list< Unit* >::reverse_iterator it = u.rbegin(); it != u.rend(); ++it)
            if (*it)
                return *it;
        return NULL;
    }

void UnitCollection::cleanup

(

)

Definition at line 212 of file oldcollection.cpp.

References UnitCollection::UnitIterator::advance(), createIterator(), and UnitCollection::UnitIterator::notDone().

{
    //NOTE: advance() will be cleaning up the list by itself
    un_iter ui = createIterator();
    while ( ui.notDone() )
        ui.advance();
}

void UnitCollection::clear

(

)

Definition at line 250 of file collection.cpp.

References fprintf.

Referenced by UnitHash3d< char[coltablesize], char[coltableacc], char[tablehuge] >::Clear(), GamePlanet::Kill(), Planet::Kill(), and UnitHash3d< char[coltablesize], char[coltableacc], char[tablehuge] >::SwapHugeAccum().

{
    if ( !activeIters.empty() ) {
        fprintf(stderr, "WARNING! Attempting to clear a collection with active iterators!\n" );
        return;
    }

    for (list< Unit* >::iterator it = u.begin(); it != u.end(); ++it) {
        (*it)->UnRef();
        (*it) = NULL;
    }
    u.clear();
}

void UnitCollection::clear ( )

inline

Definition at line 348 of file oldcollection.h.

    {
        destr();
        init();
    }

ConstFastIterator UnitCollection::constFastIterator ( ) const

inline

Definition at line 166 of file collection.h.

Referenced by Unit::querySphere().

    {
        return ConstFastIterator( this );
    }

ConstFastIterator UnitCollection::constFastIterator ( ) const

inline

Definition at line 326 of file oldcollection.h.

    {
        return ConstFastIterator( u );
    }

ConstIterator UnitCollection::constIterator ( ) const

inline

Definition at line 162 of file collection.h.

References ConstIterator.

Referenced by Radar::Sensor::FindTracksInRange(), findUnitInStarsystem(), front(), NetServer::sendCargoSnapshot(), and Unit::Target().

    {
        return ConstIterator( this );
    }

ConstIterator UnitCollection::constIterator ( ) const

inline

Definition at line 318 of file oldcollection.h.

References ConstIterator.

    {
        return ConstIterator( u );
    }

bool UnitCollection::contains

(

const class Unit *

)

const

bool UnitCollection::contains

(

const Unit *

unit)

const

Definition at line 275 of file collection.cpp.

References Unit::Killed().

{
    if (u.empty() || !unit)
        return false;
    for (list< Unit* >::const_iterator it = u.begin(); it != u.end(); ++it)
        if ( (*it) == unit && !(*it)->Killed() )
            return true;
    return false;
}

UnitIterator UnitCollection::createIterator ( )

inline

Definition at line 154 of file collection.h.

References UnitIterator.

Referenced by StarSystem::AddUnit(), Planet::PlanetIterator::advance(), AllUnitsCloseAndEngage(), Arrested(), Unit::AutoPilotToErrorMessage(), Planet::beginElement(), StarSystem::Statistics::CheckVitals(), ChooseNearNavPoint(), ChooseTargets(), cleanup(), Terrain::Collide(), compute_light_dot(), createObjects(), DockToSavedBases(), DoDockingOps(), GameStarSystem::Draw(), FireKeyboard::Execute(), front(), getAtmospheric(), getNearestTarget(), getNearestTargetUnit(), GetThreat(), Planet::GetTopPlanet(), ZoneMgr::getZoneBuffer(), HelpOut(), Iteration(), GamePlanet::Kill(), Planet::Kill(), KillDuplicateUnits(), main(), Planet::PlanetIterator::PlanetIterator(), UnitHash3d< char[coltablesize], char[coltableacc], char[tablehuge] >::removeFromVector(), StarSystem::RemoveUnit(), ClickList::requestIterator(), StarSystem::RequestPhysics(), ClickList::requestShip(), Unit::ReTargetFg(), UniverseUtil::SafeStarSystemEntrancePoint(), Orders::FormUpToOwner::SetParent(), StarSystem::StarSystem(), UniverseUtil::StopTargettingEachOther(), UniverseUtil::TargetEachOther(), GameUnit< UnitType >::TransferUnitToSystem(), UnDockNow(), Unit::UpAndDownGrade(), Atmosphere::Update(), StarSystem::Update(), Cockpit::Update(), Cockpit::updateAttackers(), StarSystem::UpdateMissiles(), StarSystem::UpdateUnitPhysics(), and StarSystem::~StarSystem().

    {
        return UnitIterator( this );
    }

UnitIterator UnitCollection::createIterator ( )

inline

Definition at line 314 of file oldcollection.h.

References UnitIterator.

    {
        return UnitIterator( u );
    }

bool UnitCollection::empty ( ) const

inline

Definition at line 174 of file collection.h.

Referenced by UnitHash3d< char[coltablesize], char[coltableacc], char[tablehuge] >::Clear(), Unit::DealDamageToHullReturnArmor(), Radar::Track::HasTurrets(), Unit::InsideCollideTree(), main(), UnitCollection::ConstIterator::operator*(), Unit::querySphere(), Unit::rayCollide(), RecursiveSetSchedule(), Unit::Repair(), and GameUnit< UnitType >::UpgradeSubUnits().

    {
        if (u.size()-removedIters.size() > 0) return false;
        return true;
    }

bool UnitCollection::empty ( ) const

inline

Definition at line 310 of file oldcollection.h.

    {
        return u->next->unit == NULL;
    }

void UnitCollection::erase ( std::list< class Unit * >::iterator &  )

inline

Definition at line 285 of file collection.cpp.

References i.

Referenced by remove().

{
    if ( !(*it2) ) {
        ++it2;
        return;
    }
    //If we have more than 4 iterators, just push node onto vector.
    if (activeIters.size() > 3) {
        removedIters.push_back( it2 );
        (*it2)->UnRef();
        (*it2) = NULL;
        ++it2;
        return;
    }
    //If we have between 2 and 4 iterators, see if any are actually
    //on the node we want to remove, if so, just push onto vector.
    //Purpose : This special case is to reduce the size of the list in the
    //situation where removedIters isn't being processed.
    if (activeIters.size() > 1)
        for (vector<UnitCollection::UnitIterator*>::size_type i = 0; i < activeIters.size(); ++i)
            if (activeIters[i]->it == it2) {
                removedIters.push_back( it2 );
                (*it2)->UnRef();
                (*it2) = NULL;
                ++it2;
                return;
            }
    //If we have 1 iterator, or none of the iterators are currently on the
    //requested node to be removed, then remove it right away.
    (*it2)->UnRef();
    (*it2) = NULL;
    it2    = u.erase( it2 );
}

FastIterator UnitCollection::fastIterator ( )

inline

Definition at line 158 of file collection.h.

Referenced by CalculateNearestWarpUnit(), and Unit::rayCollide().

    {
        return FastIterator( this );
    }

FastIterator UnitCollection::fastIterator ( )

inline

Definition at line 322 of file oldcollection.h.

    {
        return FastIterator( u );
    }

void UnitCollection::FreeUnusedNodes ( )

static

Definition at line 59 of file oldcollection.cpp.

References PushUnusedNode().

Referenced by main().

{
    static std::vector< UnitCollection::UnitListNode* >bakdogpile;
    std::vector< UnitCollection::UnitListNode* > *dogpile = (std::vector< UnitCollection::UnitListNode* >*)PushUnusedNode(
        NULL );
    bakdogpile.swap( *dogpile );
    while ( !dogpile->empty() ) {
        delete dogpile->back();
        dogpile->pop_back();
    }
}

Unit* UnitCollection::front ( )

inline

Definition at line 228 of file collection.h.

    {
        for (std::list< Unit* >::iterator it = u.begin(); it != u.end(); ++it)
            if (*it)
                return *it;
        return NULL;
    }

Unit* UnitCollection::front ( )

inline

Definition at line 356 of file oldcollection.h.

References createIterator().

    {
        return *createIterator();
    }

const Unit* UnitCollection::front ( ) const

inline

Definition at line 360 of file oldcollection.h.

References constIterator().

    {
        return *constIterator();
    }

void UnitCollection::insert	(	std::list< Unit * >::iterator &	,
		Unit *
	)

Definition at line 241 of file collection.cpp.

References Unit::Ref().

{
    if (unit) {
        unit->Ref();
        temp = u.insert( temp, unit );
    }
    temp = u.end();
}

void UnitCollection::insert_unique

(

Unit *

unit)

Definition at line 190 of file collection.cpp.

References Unit::Ref().

{
    if (unit) {
        for (list< Unit* >::iterator it = u.begin(); it != u.end(); ++it)
            if (*it == unit)
                return;
        unit->Ref();
        u.push_front( unit );
    }
}

void UnitCollection::insert_unique ( Unit *  un)

inline

Definition at line 330 of file oldcollection.h.

References i, and prepend().

    {
        for (UnitListNode *i = u->next; i != NULL; i = i->next)
            if (i->unit == un) return;
        prepend( un );
    }

const UnitCollection& UnitCollection::operator=

(

const UnitCollection &

c)

void UnitCollection::prepend

(

Unit *

unit)

Definition at line 201 of file collection.cpp.

References Unit::Ref().

Referenced by UnitHash3d< char[coltablesize], char[coltableacc], char[tablehuge] >::AddHugeToActive(), Planet::AddSatellite(), Planet::AddSpaceElevator(), AddSubUnits(), StarSystem::AddUnit(), Planet::beginElement(), Planet::InitPlanet(), insert_unique(), main(), UnitCollection::UnitIterator::moveBefore(), UnitHash3d< char[coltablesize], char[coltableacc], char[tablehuge] >::Put(), ClickList::requestIterator(), and Unit::UpAndDownGrade().

{
    if (unit) {
        unit->Ref();
        u.push_front( unit );
    }
}

void UnitCollection::prepend

(

UnitIterator *

it)

Definition at line 209 of file collection.cpp.

References UnitCollection::UnitIterator::advance(), and Unit::Ref().

{
    Unit *tmp = NULL;
    if (!it) return;
    list< Unit* >::iterator tmpI = u.begin();
    while ( (tmp = **it) ) {
        tmp->Ref();
        u.insert( tmpI, tmp );
        ++tmpI;
        it->advance();
    }
}

void UnitCollection::prepend ( Unit *  unit)

inline

Definition at line 336 of file oldcollection.h.

    {
        u->next = new UnitListNode( unit, u->next );
    }

void UnitCollection::prepend ( UnitListNode *  unitlistnode)

inline

Definition at line 340 of file oldcollection.h.

    {
        unitlistnode->next = u->next;
        u->next = unitlistnode;
    }

void UnitCollection::prepend

(

UnitIterator *

iter)

void * UnitCollection::PushUnusedNode ( UnitListNode *  node)

static

Definition at line 42 of file oldcollection.cpp.

Referenced by FreeUnusedNodes().

{
    static UnitListNode cat( NULL, NULL );
    static UnitListNode dog( NULL, &cat );
    static bool cachunk = true;
    if (cachunk)
        cachunk = false;
    //VSFileSystem::vs_fprintf (stderr,"%x %x",&dog,&cat);
    static std::vector< UnitCollection::UnitListNode* >dogpile;
    if (node == NULL) {
        return &dogpile;
    } else {
        node->next = &dog;
        dogpile.push_back( node );
    }
    return NULL;
}

bool UnitCollection::remove

(

const class Unit *

)

bool UnitCollection::remove

(

const Unit *

unit)

Definition at line 319 of file collection.cpp.

References erase().

{
    bool res = false;
    if (u.empty() || !unit)
        return false;
    for (list< Unit* >::iterator it = u.begin(); it != u.end();) {
        if ( (*it) == unit ) {
            erase( it );
            res = true;
        } else {
            ++it;
        }
    }
    return res;
}

const int UnitCollection::size ( ) const

inline

Definition at line 213 of file collection.h.

Referenced by UnitHash3d< char[coltablesize], char[coltableacc], char[tablehuge] >::Clear().

    {
        return u.size()-removedIters.size();
    }

Friends And Related Function Documentation

friend class ConstIterator

friend

Definition at line 238 of file collection.h.

Referenced by constIterator().

friend class UnitIterator

friend

Definition at line 237 of file collection.h.

Referenced by createIterator().

---

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

• src/cmd/collection.h
• src/cmd/oldcollection.h
• src/cmd/collection.cpp
• src/cmd/oldcollection.cpp