distributedRegion.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2001 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: distributedRegion.h,v $ $Revision: 1.6 $ $State: Exp $
*********************************************************************/
#ifndef distributedRegion_H_
#define distributedRegion_H_
#ifdef DDM


#include "rtiMsConfig.h"
#include "region.h"
#include <vlutil/vlMachineTypes.h>
#include "internalTypes.h"
#include "regionSetList.h"
#include "dimRangeBounds.h"

class DtRtiSaveFile;
class DtSpaceInfo;
class DtRegionRealization;
class DtObjectRegionSet;
class DtInteractionRegionSet;
class DtFomClassMgr;

class DT_DLL_LRC DtDistributedRegion : public DtRegion
{
public:

   DtDistributedRegion();

   DtDistributedRegion(DtRegionHandle handleValue, const DtSpaceInfo* space,
      DtDimensionHandleSet const & dimHandles, unsigned long numberExtents=1);

   DtDistributedRegion(DtRegionHandle regionHandle, const DtSpaceInfo* space,
      unsigned long numberExtents);

   DtDistributedRegion(DtRegionHandle regionHandle, const DtSpaceInfo* space,
            const DtRegionExtent* extentList, unsigned long numberExtents);

   virtual ~DtDistributedRegion();

private:
   
   DtDistributedRegion(DtDistributedRegion const& );

   DtDistributedRegion& operator= (DtDistributedRegion const& );

public:

   virtual unsigned long getRangeLowerBound(
      DtExtentIndex     extentIndex,
      DtDimensionHandle dimensionHandle) const;
   virtual void setRangeLowerBound(
      DtExtentIndex     extentIndex,
      DtDimensionHandle dimensionHandle,
      unsigned long     lowerBound);

   virtual unsigned long getRangeUpperBound(
      DtExtentIndex     extentIndex,
      DtDimensionHandle dimensionHandle) const;
   virtual void setRangeUpperBound(
      DtExtentIndex     extentIndex,
      DtDimensionHandle dimensionHandle,
      unsigned long     upperBound);

   virtual DtRegionHandle handle() const;
   virtual void setHandle(DtRegionHandle handleValue);

   virtual const DtSpaceInfo* space() const;
   virtual void setSpace(const DtSpaceInfo* space);

   virtual DtSpaceHandle getSpaceHandle() const;

   virtual DtDimensionHandleSet const & dimensionHandles() const;

   virtual bool hasDimension(DtDimensionHandle dimHandle) const;

   virtual unsigned long getNumberOfExtents() const;

   virtual void commitModifications();

   virtual bool inUse() const;

   virtual void addRealization(DtRegionRealization* realization);
   virtual void removeRealization(DtRegionHandle handleValue);

   virtual bool validForService() const;

   virtual bool wasCommited() const;

   virtual bool validExtents() const;

   virtual unsigned long addExtent();

   virtual void setExtents(const DtRegionExtent* extentList,
      unsigned long numberExtents);
   virtual void setExtents(std::vector<const DtRegionExtent*> extentList);
   virtual const DtRegionExtent* getExtents() const;

   virtual void addExtents(const DtRegionExtent* extentList,
      unsigned long numberExtents);

   virtual void setDimensionExtent(DtExtentIndex extentIndex,
      DtDimensionHandle dim,  unsigned long lower, unsigned long upper);

   virtual void setDimensionExtent(DtExtentIndex extentIndex,
      DtDimBounds const & dimBounds);

   virtual DtDimBounds getDimensionExtent(DtExtentIndex extentIndex,
      DtDimensionHandle dim) const;

   virtual bool intersect(const DtDistributedRegion& region) const;

   virtual bool intersect(const DtRegionExtent& extent) const;

   virtual bool save( DtRtiSaveFile& file, DtFederateHandle handle = 0);

   virtual bool restore( DtRtiSaveFile& file, DtFederateHandle& fedHandle,
                              DtFomClassMgr* fom);

protected:

   virtual void createWorkingExtents();

   virtual const DtRegionExtent& extent(DtExtentIndex extentIndex) const;

protected:

   DtRegionHandle myHandle;

   const DtSpaceInfo* mySpace;

   DtDimensionHandleSet myDimensions;

   unsigned long myNumberExtents;

   DtRegionExtent* myExtents;

   DtRegionExtent* myWorkingExtents;

   bool myCommited;

   bool myValidForService;

   MAKRti::DtHashlist myRealizations;
};

#endif //! DDM
#endif //! distributedRegion