madara::expression::PreOrderIteratorImpl Class Reference

Iterates through an ExpressionTree in level-order. More...

#include <IteratorImpl.h>

Inheritance diagram for madara::expression::PreOrderIteratorImpl:

Collaboration diagram for madara::expression::PreOrderIteratorImpl:

Public Types
typedef int	difference_type
typedef ::std::forward_iterator_tag	iterator_category
typedef int *	pointer
typedef int &	reference
typedef madara::knowledge::KnowledgeRecord	value_type

Public Member Functions
	PreOrderIteratorImpl (const ExpressionTree &tree, bool end_iter=false)
	Construct an LevelOrderExpressionTreeIterator. More...
virtual	~PreOrderIteratorImpl ()
	Dtor. More...
virtual ExpressionTreeIteratorImpl *	clone (void)
	Method for cloning an impl. Necessary for post increments. More...
virtual bool	operator!= (const ExpressionTreeIteratorImpl &lhs) const
	Nonequality operator. More...
virtual ExpressionTree	operator* (void)
	Dereference operator returns a reference to the item contained at the current position. More...
virtual const ExpressionTree	operator* (void) const
	Returns a const reference to the item contained at the current position. More...
virtual void	operator++ (void)
	Increment operator (used for both pre- and post-increment). More...
virtual bool	operator== (const ExpressionTreeIteratorImpl &rhs) const
	Equality operator. More...

Protected Attributes
const ExpressionTree &	tree_
	The tree we are iterating over. More...

Private Attributes
madara::utility::LStack< ExpressionTree >	stack_
	Our current position in the iteration. More...

Friends
class	ExpressionTreeIterator
class	utility::Refcounter< ExpressionTreeIteratorImpl >

Detailed Description

Iterates through an ExpressionTree in level-order.

Plays the role of the "implementor" class in the Bridge pattern that defines the level-order iteration algorithm.

Definition at line 148 of file IteratorImpl.h.

Member Typedef Documentation

typedef int madara::expression::PreOrderIteratorImpl::difference_type

Definition at line 190 of file IteratorImpl.h.

typedef ::std::forward_iterator_tag madara::expression::PreOrderIteratorImpl::iterator_category

Definition at line 186 of file IteratorImpl.h.

typedef int* madara::expression::PreOrderIteratorImpl::pointer

Definition at line 188 of file IteratorImpl.h.

typedef int& madara::expression::PreOrderIteratorImpl::reference

Definition at line 189 of file IteratorImpl.h.

typedef madara::knowledge::KnowledgeRecord madara::expression::PreOrderIteratorImpl::value_type

Definition at line 187 of file IteratorImpl.h.

Constructor & Destructor Documentation

madara::expression::PreOrderIteratorImpl::PreOrderIteratorImpl	(	const ExpressionTree &	tree,
		bool	end_iter = false
	)

Construct an LevelOrderExpressionTreeIterator.

Construct an PreOrderExpressionTreeIterator.

If end_iter is set to true, the iterator points to the end of the tree. Otherwise, the iterator starts with a free tree.

If end_iter is set to true, the iterator points to the end of the tree

Definition at line 168 of file IteratorImpl.cpp.

madara::expression::PreOrderIteratorImpl::~PreOrderIteratorImpl ( void  )

virtual

Dtor.

destructor - nothing to do

Definition at line 181 of file IteratorImpl.cpp.

Member Function Documentation

madara::expression::ExpressionTreeIteratorImpl * madara::expression::PreOrderIteratorImpl::clone ( void  )

virtual

Method for cloning an impl. Necessary for post increments.

Method for cloning an impl.

Necessary for post increments (bridge)

See also

ExpressionTreeIterator

Implements madara::expression::ExpressionTreeIteratorImpl.

Definition at line 292 of file IteratorImpl.cpp.

bool madara::expression::PreOrderIteratorImpl::operator!= ( const ExpressionTreeIteratorImpl &  lhs ) const

virtual

Nonequality operator.

checks two iterators for inequality

Implements madara::expression::ExpressionTreeIteratorImpl.

Definition at line 281 of file IteratorImpl.cpp.

madara::expression::ExpressionTree madara::expression::PreOrderIteratorImpl::operator* ( void  )

virtual

Dereference operator returns a reference to the item contained at the current position.

Returns the Node that the iterator is pointing to (non-const version)

Implements madara::expression::ExpressionTreeIteratorImpl.

Definition at line 190 of file IteratorImpl.cpp.

const madara::expression::ExpressionTree madara::expression::PreOrderIteratorImpl::operator* ( void  ) const

virtual

Returns a const reference to the item contained at the current position.

Returns the Node that the iterator is pointing to (const version)

Implements madara::expression::ExpressionTreeIteratorImpl.

Definition at line 198 of file IteratorImpl.cpp.

void madara::expression::PreOrderIteratorImpl::operator++ ( void  )

virtual

Increment operator (used for both pre- and post-increment).

moves the iterator to the next node (pre-increment)

Implements madara::expression::ExpressionTreeIteratorImpl.

Definition at line 206 of file IteratorImpl.cpp.

bool madara::expression::PreOrderIteratorImpl::operator== ( const ExpressionTreeIteratorImpl &  rhs ) const

virtual

Equality operator.

checks two iterators for equality

Implements madara::expression::ExpressionTreeIteratorImpl.

Definition at line 232 of file IteratorImpl.cpp.

Friends And Related Function Documentation

friend class ExpressionTreeIterator

friend

Definition at line 150 of file IteratorImpl.h.

friend class utility::Refcounter< ExpressionTreeIteratorImpl >

friend

Definition at line 151 of file IteratorImpl.h.

Member Data Documentation

madara::utility::LStack<ExpressionTree> madara::expression::PreOrderIteratorImpl::stack_

private

Our current position in the iteration.

Definition at line 194 of file IteratorImpl.h.

const ExpressionTree& madara::expression::ExpressionTreeIteratorImpl::tree_

protectedinherited

The tree we are iterating over.

Definition at line 83 of file IteratorImpl.h.

---

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

• include/madara/expression/IteratorImpl.h
• include/madara/expression/IteratorImpl.cpp