include/gdb/specification.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2003 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: specification.h,v $ $Revision: 1.14 $ $State: Exp $
*******************************************************************************/
#ifndef specification_H_
#define specification_H_

//
// \file specification.h
// \brief Contains the declaration of the DtSpecification class.
//

#include "gdb/gdbDefines.h"
#include <stdio.h>
#include <vlutil/vlString.h>
#include "geometry/gdbColor.h"
#include <vlutil/vlList.h>
#include "gdb/specAttrib.h"


// The DtSpecification class represents the meta-data associated with a vector network
// feature.  It is a collection of attributes, each a key-value pair, and provides
// an interface for setting and getting the associated attributes.
class DT_DLL_gdb DtSpecification
{

public:

   typedef DtList DtSpecAttributeContainer;
   typedef DtString DtAttributeKey;


   // default constructor
   DtSpecification();

   // destructor
   virtual ~DtSpecification();

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

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

   // @name Comparison operators
   virtual bool operator==(const DtSpecification& other) const;
   virtual bool operator!=(const DtSpecification& other) const;
   
   // If the specified specification contains all of the attributes of this
   // specification, then this specification is a superset of the specified
   // specification.  
   virtual bool isASupersetOf(const DtSpecification& other) const;

   // accessor / mutator functions
   virtual const DtColor& color() const;
   virtual void setColor(const DtColor& c);

   // returns a string that describes the surface characteristic.
   virtual DtString specificationString() const;

   // debugging aid
   virtual void dump() const;

   // get/set length
   virtual double length() const;
   virtual void setLength(double val);

   // get/set width
   virtual double width() const;
   virtual void setWidth(double val);

   // get/set rotation of the object about the Z-axis in degrees (0 if not specified)
   virtual int rotationAboutZ() const;
   virtual void setRotationAboutZ(int angleInDegrees);

   // get/set visible flag
   virtual bool visible() const;
   virtual void setVisible(bool val);

   // get a radius for drawing nodes
   virtual double drawingRadius() const;

   // add (as copy) and lookup an attribute
   virtual void addAttribute(const DtSpecificationAttribute& att);
   
   virtual void removeAttribute(const DtSpecificationAttribute& att);
   virtual void removeAttribute(const DtAttributeKey& label);

   virtual DtSpecificationAttribute* attribute(const DtString& label);
   virtual const DtSpecificationAttribute* attribute(const DtString& label) const;

   // add and lookup an integer attribute
   virtual void addIntegerAttribute(const DtString& label, int value);
   virtual bool lookupIntegerAttribute(const DtString& label, int& value) const;

   // add and lookup a real attribute
   virtual void addRealAttribute(const DtString& label, double value);
   virtual bool lookupRealAttribute(const DtString& label, double& value) const;

   // add and lookup a string attribute
   virtual void addStringAttribute(const DtString& label, const DtString& value);
   virtual bool lookupStringAttribute(const DtString& label, DtString& value) const;

   // check for existence and return attribute pointer
   virtual const DtSpecificationAttribute* attributeOfType(const DtString& label, 
                                                           unsigned int type) const;

   // input/output functions
   virtual bool readFrom(FILE* fp);
   virtual bool writeTo(FILE* fp);

   // return a null specification
   static const DtSpecification& nullSpecification();

   // Returns the list of all attributes
   virtual const DtSpecAttributeContainer& attributes() const;

protected:

   // specification attribute factory method
   virtual DtSpecificationAttribute* newAttribute(unsigned int type);

protected:

   DtColor                  myColor;
   bool                     myVisible;
   DtSpecAttributeContainer myAttributes;

   static const DtString theLengthString;
   static const DtString theWidthString;
   static const DtString theOrientationString;

   static const DtSpecification theNullSpecification;
};

#endif