dimRangeBounds.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2001 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: dimRangeBounds.h,v $ $Revision: 1.9 $ $State: Exp $
*********************************************************************/

#ifndef DtRangeBounds_H_
#define DtRangeBounds_H_

#ifdef DDM

#include "rtiMsConfig.h"
#include <vlutil/vlMachineTypes.h>
#include "internalTypes.h"
#include <map>

enum DtBoundsCheck
{
   DtInvalidBounds,
   DtValidLowerBound,
   DtValidUpperBound,
   DtValidBounds
};

class DT_DLL_LRC DtRangeBounds
{
public:

   DtRangeBounds();

   DtRangeBounds(unsigned long lowerBound, unsigned long upperBound,
      unsigned long maxBound);

   ~DtRangeBounds()
      throw ();

   DtRangeBounds(DtRangeBounds const & rhs);

   DtRangeBounds &operator=(DtRangeBounds const & rhs);

   void setLowerBound(unsigned long lowerBound);
   unsigned long getLowerBound() const;

   void setUpperBound(unsigned long upperBound);
   unsigned long getUpperBound() const;

   void setMaxBound(unsigned long max);
   unsigned long getMaxBound() const;

   int overlap(DtRangeBounds const & rangeBound) const;

   DtBoundsCheck boundsCheck() const;

protected:

   unsigned long myLowerBound;
   unsigned long myUpperBound;
   unsigned long myMaxBound;
   DtBoundsCheck myBoundsCheck;
};

inline unsigned long DtRangeBounds::getLowerBound() const
{
   return myLowerBound;
}

inline unsigned long DtRangeBounds::getUpperBound() const
{
   return myUpperBound;
}

inline unsigned long DtRangeBounds::getMaxBound() const
{
   return myMaxBound;
}

inline DtBoundsCheck DtRangeBounds::boundsCheck() const
{
   return myBoundsCheck;
}

class DT_DLL_LRC DtDimBounds : public DtRangeBounds
{
public:

   DtDimBounds();

   DtDimBounds(unsigned long lowerBound, unsigned long upperBound,
      unsigned long maxBound);

   ~DtDimBounds()
      throw ();

   DtDimBounds(DtDimBounds const & rhs);

   DtDimBounds &operator=(DtDimBounds const & rhs);

   bool operator==(DtDimBounds const & rhs);

   DtDimensionHandle getDimension() const;

   void setDimension(DtDimensionHandle dimValue);

protected:

   DtDimensionHandle myDimension;
};

inline DtDimensionHandle DtDimBounds::getDimension() const
{
   return myDimension;
}

class DT_DLL_LRC DtRegionExtent
{
public:
   
   DtRegionExtent();

   DtRegionExtent(DtRegionExtent const & rhs);

   ~DtRegionExtent()
      throw ();

   DtRegionExtent &operator=(DtRegionExtent const & rhs);

   unsigned long getNumberDimensions() const;

   void getDimensionHandles(DtDimensionHandleSet& dimHandles) const;

   void addDimension(DtDimensionHandle dim);
   void removeDimension(DtDimensionHandle dim);

   unsigned long getLowerBound(DtDimensionHandle dimension) const;
   void setLowerBound(DtDimensionHandle dimension, unsigned long lowerBound);

   unsigned long getUpperBound(DtDimensionHandle dimension) const;
   void setUpperBound(DtDimensionHandle dimension, unsigned long upperBound);

   unsigned long getMaxBound(DtDimensionHandle dimension) const;
   void setMaxBound(DtDimensionHandle dimension, unsigned long max);
  
   void setRangeBound(DtDimensionHandle dimension, unsigned long lowerBound,
      unsigned long upperBound);
   void setRangeBound(DtDimensionHandle dimension, DtRangeBounds extent);
   void setRangeBound(DtDimBounds extent);
   DtDimBounds getRangeBound(DtDimensionHandle dimension) const;

   bool overlap(DtRegionExtent const & extent) const;

   bool hasDimension(DtDimensionHandle dimHandle);

   bool validExtents();

   unsigned long encodedLength() const;

   void encode(void* buffer, unsigned long bufferSize) const;

   void decode(void* buffer, unsigned long dimCount);

public:
   static const DtDimBounds theInvalidExtent;

protected:
   typedef std::map<DtDimensionHandle, DtDimBounds> DtExtentMap; 
   DtExtentMap myExtents;
};

#endif
#endif