unit_map::unit_iterator Struct Reference

For iterating over every unit. More...

#include <unit_map.hpp>

Collaboration diagram for unit_map::unit_iterator:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 unit_iterator ()
 unit_iterator (const unit_iterator &i)
 unit_iterator (umap::iterator i, unit_map *map)
std::pair< gamemap::location,
unit > * 
operator-> () const
std::pair< gamemap::location,
unit > & 
operator* () const
unit_iterator operator++ ()
unit_iterator operator++ (int)
bool operator== (const unit_iterator &that) const
bool operator!= (const unit_iterator &that) const
bool valid () const

Private Attributes

iterator_counter counter
umap::iterator i_
unit_mapmap_

Friends

struct const_unit_iterator
struct unit_xy_iterator
struct const_unit_xy_iterator
struct xy_accessor
struct const_xy_accessor


Detailed Description

For iterating over every unit.

Iterator is valid as long as there is there is a unit w/ matching underlying_id in the map.

Definition at line 101 of file unit_map.hpp.


Constructor & Destructor Documentation

unit_map::unit_iterator::unit_iterator (  )  [inline]

Definition at line 103 of file unit_map.hpp.

Referenced by operator++().

unit_map::unit_iterator::unit_iterator ( const unit_iterator i  )  [inline]

Definition at line 105 of file unit_map.hpp.

unit_map::unit_iterator::unit_iterator ( umap::iterator  i,
unit_map map 
) [inline]

Definition at line 106 of file unit_map.hpp.


Member Function Documentation

std::pair< gamemap::location, unit > * unit_map::unit_iterator::operator-> (  )  const

Definition at line 59 of file unit_map.cpp.

References i_, and valid().

std::pair< gamemap::location, unit > & unit_map::unit_iterator::operator* (  )  const

Definition at line 65 of file unit_map.cpp.

References i_, and valid().

unit_map::unit_iterator unit_map::unit_iterator::operator++ (  ) 

Definition at line 71 of file unit_map.cpp.

References i_, unit_map::map_, map_, and valid().

unit_map::unit_iterator unit_map::unit_iterator::operator++ ( int   ) 

Definition at line 83 of file unit_map.cpp.

References i_, unit_map::map_, map_, unit_iterator(), and valid().

bool unit_map::unit_iterator::operator== ( const unit_iterator that  )  const [inline]

Definition at line 115 of file unit_map.hpp.

References i_.

bool unit_map::unit_iterator::operator!= ( const unit_iterator that  )  const [inline]

Definition at line 118 of file unit_map.hpp.

References i_.

bool unit_map::unit_iterator::valid (  )  const [inline]


Friends And Related Function Documentation

friend struct const_unit_iterator [friend]

Definition at line 124 of file unit_map.hpp.

friend struct unit_xy_iterator [friend]

Definition at line 125 of file unit_map.hpp.

friend struct const_unit_xy_iterator [friend]

Definition at line 126 of file unit_map.hpp.

friend struct xy_accessor [friend]

Definition at line 127 of file unit_map.hpp.

friend struct const_xy_accessor [friend]

Definition at line 128 of file unit_map.hpp.


Member Data Documentation

Definition at line 131 of file unit_map.hpp.

umap::iterator unit_map::unit_iterator::i_ [private]

Definition at line 134 of file unit_map.hpp.

Referenced by operator++(), and valid().


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

Generated by doxygen 1.5.5 on 23 May 2008 for The Battle for Wesnoth
Gna! | Forum | Wiki | CIA | devdocs