networkEdgeReverseSegmentIter.h

Go to the documentation of this file.

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

//
// \file networkEdgeReverseSegmentIter.h
// \brief Contains the DtNetworkEdgeReverseSegmentIter class declaration.
//

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

class DtNetworkSegment;
class DtString;

//
// DtNetworkEdgeReverseSegmentIter is a bidirectional iterator over the segments
// representing a DtNetworkEdge, traversing in the REVERSE direction.
// \invariant At all times, this iterator must point to a *valid* DtNetworkEdge.
class DT_DLL_gdb DtNetworkEdgeReverseSegmentIter : public DtNetworkEdgeSegmentIter
{
public:
   // constructor
   // \param edge The DtNetworkEdge to iterate over
   DtNetworkEdgeReverseSegmentIter(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.
   DtNetworkEdgeReverseSegmentIter(DtNetworkEdge& edge,
                                 DtNetworkEdge::DtSegmentReverseIter segmentReverseIter);
   
   // destructor
   virtual ~DtNetworkEdgeReverseSegmentIter();

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

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

   // \returns the start or end points of the current segment as defined by the direction
   // of traversal. (i.e., this is a reverse segment iter, so the actual segments endpoint
   // will be returned as the start point, and vice versa.)
   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 DtNetworkEdgeReverseSegmentIter& other) const;

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

   // \return the DtString "DtNetworkEdgeReverseSegmentIter"
   virtual const DtString type() const;
  
protected:
   DtNetworkEdge::DtSegmentReverseIter mySegmentReverseIter;

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


#endif