include/gdb/networkEdgeReversePointConstIter.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: networkEdgeReversePointConstIter.h,v $ $Revision: 1.5 $ $State: Exp $
*********************************************************************/
#ifndef networkEdgeReversePointConstIter_H_
#define networkEdgeReversePointConstIter_H_

//
// \file networkEdgeReversePointConstIter.h
// \brief Contains the DtNetworkEdgeReversePointConstIter class declaration.
//

#include "gdb/gdbDefines.h"
#include "gdb/netwrkEdge.h"
#include "gdb/networkEdgePointConstIter.h"

class DtPoint;
class DtString;

// DtNetworkEdgeReversePointConstIter is a bidirectional iterator over the points 
// representing a DtNetworkEdge, traversing in the REVERSE direction.
// \invariant At all times, this iterator must point to a valid DtNetworkEdge.
class DT_DLL_gdb DtNetworkEdgeReversePointConstIter : public DtNetworkEdgePointConstIter
{
public:

   // constructor
   // \param edge The DtNetworkEdge to iterate over
   DtNetworkEdgeReversePointConstIter(const DtNetworkEdge& edge);

   // constructor that allows the user to specify that
   // the iterator is initialized to the end of the 
   // points of the edge.
   // \param edge The DtNetworkEdge to iterate over
   // \param isEnd Is the iterator at the end or not.
   DtNetworkEdgeReversePointConstIter(const DtNetworkEdge& edge,
                                      bool isEnd);

   // Constructs a reverse point iterator starting at the specified 
   // segment along the edge, which means the current point will be the ending point
   // of the specified segment.  
   // \param edge The DtNetworkEdge to iterate over
   // \param initialPoint The point in the edge to initialize to.
   // \note If the initialPoint is NOT in the edge, then the iterator is 
   // initialized to the first point as if no point had been specified.
   DtNetworkEdgeReversePointConstIter(const DtNetworkEdge& edge,
                                      const DtPoint& initialPoint);
   
   // destructor
   virtual ~DtNetworkEdgeReversePointConstIter();

   // assignment operator
   DtNetworkEdgeReversePointConstIter& operator=(const DtNetworkEdgeReversePointConstIter& orig);

   // copy constructor
   DtNetworkEdgeReversePointConstIter(const DtNetworkEdgeReversePointConstIter& orig);

   void operator++(); 
   void operator--(); 
   const DtPoint& operator*() const; 
   const DtPoint* operator->() const;

   bool operator==(const DtNetworkEdgePointConstIter& other) const;
   bool operator!=(const DtNetworkEdgePointConstIter& other) const;

   bool operator==(const DtNetworkEdgeReversePointConstIter& other) const;
   bool operator!=(const DtNetworkEdgeReversePointConstIter& other) const;

   // \return the DtString "DtNetworkEdgeReversePointConstIter"
   virtual const DtString type() const;
  
protected:
   // Used to keep track of where we are in the parent edge since the last segment
   // in either direction will have both a starting and ending point.
   DtNetworkEdge::DtPointContainer::const_reverse_iterator myReversePointConstIter;

private:
   // default constructor
   DtNetworkEdgeReversePointConstIter();
};


#endif