networkElement.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2001 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: netwrkElemnt.h,v $ $Revision: 1.15 $ $State: Exp $
*********************************************************************/
#ifndef networkElement_H_
#define networkElement_H_

//
// \file netwrkElemnt.h
// \brief This file contains the DtNetworkElement class declaration and related functionality.
//

#include "gdb/gdbDefines.h"
#include <stdio.h>
#include <vlutil/vlNetTypes.h>

class DtSpecification;
class DtVectorNetwork;


// The DtFeatureType enum represents the valid feature types for any DtSpecification for 
// a vector network element.  The values were originally defined in the DFAD
// standard, and have been used as defined here.
typedef enum
{
   DtPointFeature = 0,
   DtLinearFeature = 1,
   DtArealFeature = 2
} DtFeatureType;


class DT_DLL_gdb DtNetworkElement
{
public:

   // default constructor
   DtNetworkElement();

   // destructor
   virtual ~DtNetworkElement();

   // Relying on the compiler generated copy constructor and assignment operators
   // copy constructor
//   DtNetworkElement(const DtNetworkElement& orig);
   // assignment operator
//   DtNetworkElement& operator=(const DtNetworkElement& orig);

   // get/set array index
   virtual unsigned int arrayIndex() const;
   virtual void setArrayIndex(unsigned int val);

   // find out whether this element is part of a valid network
   virtual bool networked() const;

   // get specification
   virtual const DtSpecification& specification() const = 0;

   // get/set remove state
   virtual bool isRemoved() const;
   virtual bool isNotRemoved() const;
   virtual void setAsRemoved(bool onOff);

   // void index value
   static unsigned int voidIndex();

protected:

   bool                         myIsRemoved;
   unsigned int                 myArrayIndex;
   static const unsigned int    theVoidIndex;
};


// \return A boolean indicating whether or not the specified networkElement
// is a point feature or not.
bool DtIsPointFeature(const DtNetworkElement& networkElement);

// \return A boolean indicating whether or not the specified networkElement
// is a linear feature or not.
bool DtIsLinearFeature(const DtNetworkElement& networkElement);

// \return A boolean indicating whether or not the specified networkElement
// is an areal feature or not.
bool DtIsArealFeature(const DtNetworkElement& networkElement);



#endif