route_breadth_first_iterator

class route_breadth_first_iterator #( type T = int ) extends iterator#( T )

Provides a breadth-first iterator to a route.

T	optional The type of data collected in a route. The default is int.

Summary

route_breadth_first_iterator	Provides a breadth-first iterator to a route.
Types
route_node_type	The shorthand of the route_node type specialized with type T.
route_type	The shorthand of the route type specialized with type T.
new	Creates a route iterator.
has_next	virtual Returns 1 if the iterator has more elements.
next	virtual Returns the next element.
next_node	virtual Returns the next route_node.
remove	virtual Removes the last element returned by the iterator.

typedef route_node#( T ) route_node_type

The shorthand of the route_node type specialized with type T.

typedef route#( T ) route_type

The shorthand of the route type specialized with type T.

function new( route_type r )

Creates a route iterator.

r	A route to be iterated.

virtual function bit has_next()

virtual Returns 1 if the iterator has more elements.

If the iterator has more elements, returns 1. Otherwise, returns 0.

virtual function T next()

virtual Returns the next element.

The next element in the iterator.

virtual function route_node_type next_node()

virtual Returns the next route_node.

The next route node in the route.

virtual function void remove()

virtual Removes the last element returned by the iterator. This function can be called once per call to next or next_node.

None.