include/gdb/networkEdgeForwardPointIter.h

Go to the documentation of this file.

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

//
// \file networkEdgeForwardPointIter.h
// \brief This file contains the DtNetworkEdgeForwardPointIter class declaration.
//

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

class DtPoint;
class DtString;

// DtNetworkEdgeForwardPointIter is a bidirectional iterator over the points 
// representing a DtNetworkEdge, traversing in the FORWARD direction.
// INVARIANT:  At all times, this iterator must point to a valid DtNetworkEdge.
class DT_DLL_gdb DtNetworkEdgeForwardPointIter : public DtNetworkEdgePointIter
{
public:

   // constructor
   // \param edge The DtNetworkEdge to iterate over
   DtNetworkEdgeForwardPointIter(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.
   DtNetworkEdgeForwardPointIter(DtNetworkEdge& edge,
                                 bool isEnd);

   // Constructs a forward point iterator starting at the specified 
   // segment along the edge, which means the current point will be the starting 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.
   DtNetworkEdgeForwardPointIter(DtNetworkEdge& edge,
                                 const DtPoint& initialPoint);

   // destructor
   virtual ~DtNetworkEdgeForwardPointIter();

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

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

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

   bool operator==(const DtNetworkEdgePointIter& other) const;
   bool operator!=(const DtNetworkEdgePointIter& other) const;
   
   bool operator==(const DtNetworkEdgeForwardPointIter& other) const;
   bool operator!=(const DtNetworkEdgeForwardPointIter& other) const;

   // \return the DtString "DtNetworkEdgeForwardPointIter"
   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::iterator myPointIter;

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


#endif