VisualContext Class Reference

#include <VisualContext.h>

Collaboration diagram for VisualContext:

[legend]

Public Member Functions
	VisualContext (World *w, int i, int j)
	Constructor.
virtual	~VisualContext ()
	Empty Destructor.
void	setWorshiper (Worshiper *w)
	Set the Worshiper.
bool	legal (int i, int j) const
	Determine if a pair of absolute coordinates is legal or note.
bool	legal (std::pair< int, int > p) const
	Determine if a pair of absolute coordinates is legal or note.
bool	legal (const MoveIterator &i) const
	Determine if a movement is legal or note.
std::vector< unsigned int >	getPheromones (move_command cmd) const
	Get the understandable pheromones in a visible cell.
std::vector< unsigned int >	getPheromones (const MoveIterator &i) const
	Get the understandable pheromones in a visible cell.
std::list< WorshiperInfo >	getWorshipers (move_command cmd) const
	Get the info about worshipers present in a cell.
std::list< WorshiperInfo >	getWorshipers (const MoveIterator &i) const
	Get the info about worshipers present in a cell.
bool	haveFood (move_command cmd) const
	Detect food in a cell.
bool	haveFood (const MoveIterator &i) const
	Detect food in a cell.
bool	reachable (move_command cmd) const
	Detect if a cell is reachable.
bool	reachable (const MoveIterator &i) const
	Detect if a cell is reachable.
move_command	opposite (move_command cmd) const
	Give the opposite movement.
move_command	opposite (const MoveIterator &i) const
	Give the opposite movement.
MoveIterator	beginMove () const
	Give the beginning iterator to get the handled movements.
MoveIterator	endMove () const
	Give the end iterator to get the handled movements.
unsigned int	nbMovements () const
	Give the number of handled movements.
Protected Member Functions
Cell *	getCell (std::pair< int, int > p) const
	Return the cell given its coordinates.
Cell *	getCell (move_command cmd) const
	Return the cell from the wanted move.
Cell *	getCell (const MoveIterator &i) const
	Return the cell from the wanted move.
std::vector< unsigned int >	getPheromones (Cell *c) const
	Get the understandable pheromones in a visible cell.
std::list< WorshiperInfo >	getWorshipers (Cell *c) const
	Get the info about worshipers present in a cell.
bool	haveFood (Cell *c) const
	Detect food in a cell.
Protected Attributes
World *	_world
Worshiper *	_worshiper
int	_i
int	_j
Friends
class	World

---

Detailed Description

< The view of the World by the Worshipers

Definition at line 42 of file VisualContext.h.

---

Constructor & Destructor Documentation

VisualContext::VisualContext	(	World *	w,
		int	i,
		int	j
	)

Constructor.

Parameters:

	w	the world
	i	the vertical coordinate
	j	the horizontal coordinate

Definition at line 46 of file VisualContext.cpp.

                                                    :
    _world(w), _i(i), _j(j), _worshiper(NULL) {

}

---

Member Function Documentation

Cell * VisualContext::getCell

(

std::pair< int, int >

p

)

const [protected]

Return the cell given its coordinates.

Parameters:

p

pair of coordinates

Returns:

pointer to the cell at these coordinates

Definition at line 72 of file VisualContext.cpp.

References _world, World::getCell(), and legal().

Referenced by getCell(), getPheromones(), getWorshipers(), haveFood(), and reachable().

                                                     {
  Cell * res;

  if(legal(p)){
    res = _world->getCell(p.first, p.second);
  } else {
    throw "Illegal cell";
  }

  return res;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Cell * VisualContext::getCell

(

move_command

cmd

)

const [protected]

Return the cell from the wanted move.

Parameters:

cmd

wanted move

Returns:

pointer to the cell at these coordinates

Definition at line 84 of file VisualContext.cpp.

References _i, _j, _world, Move::getAbsCoords(), getCell(), and World::getMove().

                                                   {
  return getCell(_world->getMove()->getAbsCoords(cmd, _i, _j));
}

Here is the call graph for this function:

Cell * VisualContext::getCell

(

const MoveIterator &

i

)

const [protected]

Return the cell from the wanted move.

Parameters:

i

iterator pointing to the *Move handling the wanted movement

Returns:

pointer to the cell at these coordinates

Definition at line 88 of file VisualContext.cpp.

References _i, _j, and getCell().

                                                        {
  return getCell(i->getAbsCoords(_i, _j));
}

Here is the call graph for this function:

vector< unsigned int > VisualContext::getPheromones

(

Cell *

c

)

const [protected]

Get the understandable pheromones in a visible cell.

Return a vector of booleans. The case number i means that the pheromone number i is present in the case.

Parameters:

c

pointer to the cell

Returns:

vector of booleans

Definition at line 92 of file VisualContext.cpp.

References _worshiper, Worshiper::getColony(), Cell::getPheromones(), and NUMBER_PHEROMONES.

Referenced by getPheromones(), Warrior::think(), and Explorer::think().

                                                                {
  map<Pheromone *, unsigned int>* listPhero = c->getPheromones();
  vector<unsigned int> vect = vector<unsigned int>(NUMBER_PHEROMONES);

  Colony * colony = _worshiper->getColony();

  for(int i = 0; i < NUMBER_PHEROMONES; i++){

    map<Pheromone *, unsigned int>::iterator res =
        listPhero->find(colony->getPheromone(i));

    vect[i] = (res != listPhero->end() ? res->second : 0);

  }

  return vect;
}

Here is the call graph for this function:

Here is the caller graph for this function:

list< WorshiperInfo > VisualContext::getWorshipers

(

Cell *

c

)

const [protected]

Get the info about worshipers present in a cell.

Return a vector of WorshiperInfo (one per worshiper)

Parameters:

c

pointer to the cell

Returns:

list of WorshiperInfo

Definition at line 168 of file VisualContext.cpp.

References _worshiper, Cell::getPeople(), WorshiperInfo::setWorshiperInfo(), and WorshiperInfo::setWorshiperRequest().

Referenced by getWorshipers(), Warrior::think(), and GeneticBehaviour::think().

                                                               {
  list<Worshiper*> * l = c->getPeople();
  list<WorshiperInfo> li;

  list<Worshiper*>::iterator end_l = l->end();

  for(list<Worshiper*>::iterator it_l = l->begin();
      it_l != end_l;
      ++it_l){

    //We create a WorshiperInfo for this Worshiper and add it to the list
    WorshiperInfo w;
    w.setWorshiperInfo(*it_l);
    w.setWorshiperRequest(_worshiper);
    li.push_back(w);
  }

  return li;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool VisualContext::haveFood

(

Cell *

c

)

const [protected]

Detect food in a cell.

Parameters:

c

pointer to the cell

Returns:

true if the cell contains food, false else

Definition at line 132 of file VisualContext.cpp.

References Cell::getFood().

Referenced by haveFood(), GeneticBehaviour::think(), and Explorer::think().

                                           {
  return (c->getFood() > 0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void VisualContext::setWorshiper

(

Worshiper *

w

)

Set the Worshiper.

Parameters:

w

worshiper

Definition at line 55 of file VisualContext.cpp.

References _worshiper.

Referenced by Worshiper::setVisualContext().

                                              {
  _worshiper = w;
}

Here is the caller graph for this function:

bool VisualContext::legal	(	int	i,
		int	j
	)			const

Determine if a pair of absolute coordinates is legal or note.

Parameters:

	i	vertical coordinate
	j	horizontal coordinate

Returns:

true if they are legal, false else

Definition at line 59 of file VisualContext.cpp.

Referenced by getCell(), legal(), Warrior::think(), GeneticBehaviour::think(), and Explorer::think().

                                            {
  return (i > 0 && i < _world->_height - 1 &&
          j > 0 && j < _world->_width - 1);
}

Here is the caller graph for this function:

bool VisualContext::legal

(

std::pair< int, int >

p

)

const

Determine if a pair of absolute coordinates is legal or note.

Parameters:

p

the pair of coordinates

Returns:

true if they are legal, false else

Definition at line 64 of file VisualContext.cpp.

References legal().

                                                  {
  return legal(p.first, p.second);
}

Here is the call graph for this function:

bool VisualContext::legal

(

const MoveIterator &

i

)

const

Determine if a movement is legal or note.

Parameters:

i

iterator pointing to the *Move handling the wanted movement

Returns:

true if they are legal, false else

Definition at line 68 of file VisualContext.cpp.

References _i, _j, and legal().

                                                     {
  return legal(i->getAbsCoords(_i, _j));
}

Here is the call graph for this function:

vector< unsigned int > VisualContext::getPheromones

(

move_command

cmd

)

const

Get the understandable pheromones in a visible cell.

Return a vector of booleans. The case number i means that the pheromone number i is present in the case.

Parameters:

cmd

wanted move

Returns:

vector of booleans

Definition at line 110 of file VisualContext.cpp.

References _worshiper, getCell(), Worshiper::getColony(), Cell::getPheromones(), and NUMBER_PHEROMONES.

                                                                        {
  map<Pheromone *, unsigned int>* listPhero = getCell(cmd)->getPheromones();
  vector<unsigned int> vect = vector<unsigned int>(NUMBER_PHEROMONES);

  Colony * colony = _worshiper->getColony();

  for(int i = 0; i < NUMBER_PHEROMONES; i++){

    map<Pheromone *, unsigned int>::iterator res =
        listPhero->find(colony->getPheromone(i));

    vect[i] = (res != listPhero->end() ? res->second : 0);

  }

  return vect;
}

Here is the call graph for this function:

vector< unsigned int > VisualContext::getPheromones

(

const MoveIterator &

i

)

const

Get the understandable pheromones in a visible cell.

Return a vector of booleans. The case number i means that the pheromone number i is present in the case.

Parameters:

i

iterator pointing to the *Move handling the wanted movement

Returns:

vector of booleans

Definition at line 128 of file VisualContext.cpp.

References getCell(), and getPheromones().

                                                                             {
  return getPheromones(getCell(i));
}

Here is the call graph for this function:

list< WorshiperInfo > VisualContext::getWorshipers

(

move_command

cmd

)

const

Get the info about worshipers present in a cell.

Return a vector of WorshiperInfo (one per worshiper)

Parameters:

cmd

wanted move

Returns:

list of WorshiperInfo

Definition at line 188 of file VisualContext.cpp.

References getCell(), and getWorshipers().

                                                                       {
  return getWorshipers(getCell(cmd));
}

Here is the call graph for this function:

list< WorshiperInfo > VisualContext::getWorshipers

(

const MoveIterator &

i

)

const

Get the info about worshipers present in a cell.

Return a vector of WorshiperInfo (one per worshiper)

Parameters:

i

iterator pointing to the *Move handling the wanted movement

Returns:

list of WorshiperInfo

Definition at line 192 of file VisualContext.cpp.

References getCell(), and getWorshipers().

                                                                            {
  return getWorshipers(getCell(i));
}

Here is the call graph for this function:

bool VisualContext::haveFood

(

move_command

cmd

)

const

Detect food in a cell.

Parameters:

cmd

wanted move

Returns:

true if the cell contains food, false else

Definition at line 136 of file VisualContext.cpp.

References getCell(), and haveFood().

                                                   {
  return haveFood(getCell(cmd));
}

Here is the call graph for this function:

bool VisualContext::haveFood

(

const MoveIterator &

i

)

const

Detect food in a cell.

Parameters:

i

iterator pointing to the *Move handling the wanted movement

Returns:

true if the cell contains food, false else

Definition at line 140 of file VisualContext.cpp.

References getCell(), and haveFood().

                                                        {
  return haveFood(getCell(i));
}

Here is the call graph for this function:

bool VisualContext::reachable

(

move_command

cmd

)

const

Detect if a cell is reachable.

Parameters:

cmd

wanted move

Returns:

true if the cell is reachable, false else

Definition at line 144 of file VisualContext.cpp.

References _worshiper, getCell(), and Cell::reachable().

Referenced by Warrior::think(), GeneticBehaviour::think(), and Explorer::think().

                                                    {
  bool res = false;

  try {
    res = getCell(cmd)->reachable(_worshiper);
  } catch(...) {
    res = false;
  }

  return res;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool VisualContext::reachable

(

const MoveIterator &

i

)

const

Detect if a cell is reachable.

Parameters:

i

iterator pointing to the *Move handling the wanted movement

Returns:

true if the cell is reachable, false else

Definition at line 156 of file VisualContext.cpp.

References _worshiper, getCell(), and Cell::reachable().

                                                         {
  bool res = false;

  try {
    res = getCell(i)->reachable(_worshiper);
  } catch(...) {
    res = false;
  }

  return res;
}

Here is the call graph for this function:

move_command VisualContext::opposite

(

move_command

cmd

)

const

Give the opposite movement.

Parameters:

cmd

the command

Returns:

the opposite movement

Definition at line 196 of file VisualContext.cpp.

References _world, World::getMove(), and Move::opposite().

                                                           {
  return _world->getMove()->opposite(cmd);
}

Here is the call graph for this function:

move_command VisualContext::opposite

(

const MoveIterator &

i

)

const

Give the opposite movement.

Parameters:

i

iterator pointing to the *Move handling the wanted movement

Returns:

the opposite movement

Definition at line 200 of file VisualContext.cpp.

                                                                {
  return i->getHandledOpposite();
}

MoveIterator VisualContext::beginMove

(

)

const

Give the beginning iterator to get the handled movements.

Returns:

iterator

Definition at line 204 of file VisualContext.cpp.

References _world, Move::begin(), and World::getMove().

Referenced by Warrior::think(), GeneticBehaviour::think(), and Explorer::think().

                                            {
  return _world->getMove()->begin();
}

Here is the call graph for this function:

Here is the caller graph for this function:

MoveIterator VisualContext::endMove

(

)

const

Give the end iterator to get the handled movements.

Returns:

iterator

Definition at line 208 of file VisualContext.cpp.

References _world, Move::end(), and World::getMove().

Referenced by Warrior::think(), GeneticBehaviour::think(), and Explorer::think().

                                          {
  return _world->getMove()->end();
}

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int VisualContext::nbMovements

(

)

const

Give the number of handled movements.

Returns:

number of handled movements

Definition at line 212 of file VisualContext.cpp.

References _world, World::getMove(), and Move::size().

Referenced by Behaviour::randomMove().

                                              {
  return _world->getMove()->size();
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

Field Documentation

World* VisualContext::_world [protected]

The world

Definition at line 49 of file VisualContext.h.

Referenced by beginMove(), endMove(), getCell(), nbMovements(), and opposite().

Worshiper* VisualContext::_worshiper [protected]

The Worshiper

Definition at line 52 of file VisualContext.h.

Referenced by getPheromones(), getWorshipers(), reachable(), and setWorshiper().

int VisualContext::_i [protected]

z position

Definition at line 55 of file VisualContext.h.

Referenced by getCell(), legal(), and World::makeCommand().

int VisualContext::_j [protected]

x position

Definition at line 58 of file VisualContext.h.

Referenced by getCell(), legal(), and World::makeCommand().

---

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

• src/VisualContext.h
• src/VisualContext.cpp

---