hex::Path Class Reference

#include <hex.h>

Inheritance diagram for hex::Path:

List of all members.

---

Detailed Description

A sequence of adjacent hexes.

Definition at line 315 of file hex.h.

Public Member Functions
Area	to_area (void) const
const std::list< Hex * > &	hexes (void) const
int	length (void) const
	in units of I
std::string	steps (void) const
std::string	str (void) const
	Path (void)
	Required for list<Path>.
	Path (const std::list< Hex * > &hexes)
	Path (Hex *start, const std::string &steps) throw (hex::out_of_range,hex::invalid_argument)
	A Path starting at start, and proceeding in directions from steps.
	Path (Hex *from, const Hex *to) throw ()
	Calculates a minimum-length path between two hexes.

---

Constructor & Destructor Documentation

hex::Path::Path

(

void

)

[inline]

Required for list<Path>.

Definition at line 325 of file hex.h.

hex::Path::Path

(

const std::list< Hex * > &

hexes

)

[inline]

Definition at line 326 of file hex.h.

: _hexes(hexes) {}

hex::Path::Path	(	Hex *	start,
		const std::string &	steps
	)			throw (hex::out_of_range,hex::invalid_argument)

A Path starting at start, and proceeding in directions from steps.

Definition at line 101 of file path.cc.

  : _hexes( path(start,steps) )
{}

hex::Path::Path	(	Hex *	from,
		const Hex *	to
	)			throw ()

Calculates a minimum-length path between two hexes.

The result is one of many possible solutions.

Definition at line 107 of file path.cc.

  : _hexes( path(from,hex::steps(from,to)) )
{}

---

Member Function Documentation

Area hex::Path::to_area

(

void

)

const

Definition at line 32 of file path.cc.

{
  std::set<Hex*> result;
  std::copy(_hexes.begin(), _hexes.end(), std::inserter(result,result.end()));
  return result;
}

const std::list<Hex*>& hex::Path::hexes

(

void

)

const [inline]

Definition at line 320 of file hex.h.

Referenced by hex::svg::Document::draw_path().

{ return _hexes; }

int hex::Path::length

(

void

)

const

in units of I

Definition at line 41 of file path.cc.

Referenced by hex::Boundary::is_container().

{
  return int( _hexes.size() );
}

std::string hex::Path::steps

(

void

)

const

Definition at line 48 of file path.cc.

References hex::steps().

Referenced by str().

{
  std::string result ="";
  const Hex* curr =NULL;
  for(std::list<Hex*>::const_iterator h=_hexes.begin(); h!=_hexes.end(); ++h)
  {
    if(curr)
        result += hex::steps(curr,*h);
    curr = *h;
  }
  return result;
}

std::string hex::Path::str

(

void

)

const

Definition at line 63 of file path.cc.

References steps().

{
  assert(!this->_hexes.empty());
  std::string result =this->_hexes.front()->str();
  result+=":"+this->steps();
  return result;
}

---

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

• hex.h
• path.cc

---