include/gdb/networkEdgeForwardSegmentIter.h

Go to the documentation of this file.

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

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

class DtNetworkSegment;
class DtString;

//
// DtNetworkEdgeForwardSegmentIter is a bidirectional iterator over the segments
// representing a DtNetworkEdge, traversing in the FORWARD direction, 
// where forward is defined as the direction the segments comprise the edge in memory.
// INVARIANT:  At all times, this iterator must point to a *valid* DtNetworkEdge.
class DT_DLL_gdb DtNetworkEdgeForwardSegmentIter : public DtNetworkEdgeSegmentIter
{
public:
   // constructor
   // \param edge The DtNetworkEdge to iterate over
   DtNetworkEdgeForwardSegmentIter(DtNetworkEdge& edge);

   // Constructs a forward segment iterator starting at the specified 
   // segment along the edge
   // \param edge The DtNetworkEdge to iterate over
   // \param segmentIter A segmentIter associated with the specified edge to initialize to.
   DtNetworkEdgeForwardSegmentIter(DtNetworkEdge& edge,
      DtNetworkEdge::DtSegmentIter segmentIter);

   // destructor
   virtual ~DtNetworkEdgeForwardSegmentIter();

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

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

   // \return The start or end points of the current segment as defined by the direction
   // of traversal. (i.e., this is a forward segment iter, so the actual segments start point
   // will also be returned as the start point, etc.)
   DtPoint startPoint() const;
   DtPoint endPoint() const;

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

   bool operator==(const DtNetworkEdgeSegmentIter& other) const;
   bool operator==(const DtNetworkEdgeForwardSegmentIter& other) const;

   bool operator!=(const DtNetworkEdgeSegmentIter& other) const;
   bool operator!=(const DtNetworkEdgeForwardSegmentIter& other) const;

   // \return The DtString "DtNetworkEdgeForwardSegmentIter"
   virtual const DtString type() const;

protected:
   DtNetworkEdge::DtSegmentConstIter mySegmentIter;

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


#endif