include/gdb/netwrkSpecEl.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2001 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: netwrkSpecEl.h,v $ $Revision: 1.16 $ $State: Exp $
*********************************************************************/
#ifndef netwrkSpecEl_H_
#define netwrkSpecEl_H_

//
// \file netwrkSpecEl.h
// \brief Contains the DtNetworkSpecElement class declaration and some related utility functions.
//

#include "gdb/gdbDefines.h"
#include "gdb/netwrkElemnt.h"
#include "gdb/specMgr.h"
#include "gdb/specification.h"

#include <stdio.h>
#include <vlutil/vlPrint.h>
#include <matrix/LibMatrix.h>
#include <vlutil/vlNetTypes.h>

class DtVectorNetwork;


// DtNetworkSpecElement is the ABC for network elements that contain 
// specifications (nodes, edges, segments). It adds a specification to the 
// DtNetworkElement class.
class DT_DLL_gdb DtNetworkSpecElement : public DtNetworkElement
{
public:

   // default constructor
   DtNetworkSpecElement();

   // destructor
   virtual ~DtNetworkSpecElement();

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

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

   // Sets the specification of the network spec element.  Also updates the elements
   // specification ID as appropriate.  If the allowDuplicates parameters is true,
   // then the specification will not be shared among other similar network spec
   // elements, even if it is exactly the same.  The default is to not allow 
   // duplicates.
   // 
   // \return A boolean indicating whether or not the specification was set.
   // \note At some point in the future, this will change to throw an exception
   // rather than return a boolean value.
   virtual bool setSpecification(const DtSpecification& newSpecification, 
      bool allowDuplicates = false);

   // get/set specification index
   virtual unsigned int specificationID() const;
   virtual void setSpecificationID(DtSpecificationID specID);

   // get/set specification manager
   virtual DtSpecificationManager* specificationManager();
   virtual const DtSpecificationManager* specificationManager() const;
   virtual void setSpecificationManager(DtSpecificationManager* specManager);

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

   virtual DtString type() = 0;

protected:

   DtSpecificationID             mySpecificationID;
   DtSpecificationManager* mySpecificationManager;
};

#endif