jafar::lgl::NavGNode Struct Reference

NavGNode is the class for representing each node in the navigation graph. More...

---

Detailed Description

NavGNode is the class for representing each node in the navigation graph.

Each node corresponds to a position in the environment.

Definition at line 26 of file NavGNode.hpp.

#include <NavGNode.hpp>

List of all members.

Public Member Functions
	NavGNode (int _x=0, int _y=0)
	NavGNode (const NavLocation &_loc)
void	setPotential (double val)
	set this node potential
bool	operator== (const NavGNode &rhs) const
	Equality boolean operator.
bool	operator< (const NavGNode &rhs) const
	Operator < using lexical order.
bool	operator> (const NavGNode &rhs) const
	}}}
Public Attributes
NavLocation	pos
	{{{
double	grp
	Goal Reaching Potential.
bool	hasPotential
	Is true if the potential has been set at least once.

---

Constructor & Destructor Documentation

jafar::lgl::NavGNode::NavGNode	(	int	_x = 0,
		int	_y = 0
	)		[inline]

Parameters:

x	X position of the node
y	Y position of the node

Note:

(x,y) this is not the raster position but the true int position inside the environment

Definition at line 47 of file NavGNode.hpp.

---

Member Function Documentation

bool jafar::lgl::NavGNode::operator<

(

const NavGNode &

rhs

)

const [inline]

Operator < using lexical order.

{{{

Definition at line 80 of file NavGNode.hpp.

References pos, and jafar::lgl::NavLocation::pos_x.

bool jafar::lgl::NavGNode::operator>

(

const NavGNode &

rhs

)

const [inline]

}}}

Operator > using lexical order

{{{

Definition at line 92 of file NavGNode.hpp.

References pos, and jafar::lgl::NavLocation::pos_x.

---

Member Data Documentation

double jafar::lgl::NavGNode::grp

Goal Reaching Potential.

At each node visited during the path tracing algorithm we can evaluate the goal reaching potential

Definition at line 37 of file NavGNode.hpp.

Referenced by setPotential().

NavLocation jafar::lgl::NavGNode::pos

{{{

Nodes position held in a navigation location

Definition at line 29 of file NavGNode.hpp.

Referenced by operator<(), operator==(), and operator>().

---

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

• modules/lgl/include/lgl/NavGNode.hpp