networkSegmentHelper.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2008 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: netwrkSegHelper.h,v $ $Revision: 1.2 $ $State: Exp $
*******************************************************************************/
// \file netwrkSegHelper.h
// \brief Contains the DtNetworkSegmentHelper class declaration which wraps a
// DtNetworkSegment.  This is a convenience class that allows the setting
// of a Chord rather than depending on a DtNetworkEdge to define the segment

#ifndef networkSegmentHelper_H_
#define networkSegmentHelper_H_

#include "gdb/gdbDefines.h"
#include <vlutil/vlConfig.h>
#include "geometry/chord.h"
#include "gdb/networkSegment.h"
#include <vlutil/vlString.h>

//
// DtNetworkSegmentHelper represents a section of a network that is approximated
// by a line segment. 
class DT_DLL_gdb DtNetworkSegmentHelper : public DtNetworkSegment
{
public:

   // default constructor
   DtNetworkSegmentHelper();

   // destructor
   virtual ~DtNetworkSegmentHelper();

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

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

   // get/set chord
   virtual const DtChord chord() const;
   virtual void setChord(const DtChord& chord);

   virtual DtString type();

   // first and last endpoint, as traversing forward
   virtual DtPoint endpoint0() const;
   virtual DtPoint endpoint1() const;

protected:

   DtChord                    myChord;
};

#endif