include/vrfobjcore/embarkationSlotManager.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2005 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: embarkationSlotManager.h,v $ $Revision: 1.8 $ $State: Exp $
*******************************************************************************/


#ifndef DtEmbarkationSlotManager_H_
#define DtEmbarkationSlotManager_H_

#include <vlutil/vlConfig.h>
#include <map>
#include "vrfobjparam/loadPoint.h"
#include "vrfobjparam/slotExclusion.h"
#include "vrfutil/rwTemplatedList.h"
#include "vrfutil/rwString.h"
#include "vrfutil/rwInt.h"

class DtEmbarkationSlotEntry;
class DtVrfObject;
class DtSimManager;

#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtReservedEmbarkationSlotEntry
{
public:
   const DtEmbarkationSlotEntry* myEntry;
   std::list<DtString>           myReservedBy;

   void addReservedBy(const DtString&);
   void removeReservedBy(const DtString&);
   bool reservedBy(const DtString&) const;

};

class DT_DLL_vrfobjcore DtEmbarkationSlotInformation
{
public:
   DtEmbarkationSlotInformation() : myEntry(NULL), mySlot(-1) {};

   DtEmbarkationSlotInformation& operator=(const DtEmbarkationSlotInformation& orig)
   {
      myEntry = orig.myEntry;
      mySlot = orig.mySlot;
      myLoadPath = orig.myLoadPath;

      return *this;
   }

public:
   const DtEmbarkationSlotEntry* myEntry;
   int                           mySlot;
   std::vector<DtVector>         myLoadPath;
};

class DT_DLL_vrfobjcore DtReservedSlot : public DtReaderWriter
{
public:
   DtReservedSlot(const DtString& name, DtReaderWriterRegistry* 
      parentRegistry = NULL);
   DtReservedSlot(const DtSymbolString& name, DtReaderWriterRegistry* 
      parentRegistry = NULL);

   DtReservedSlot(const DtString& name, const 
      DtReservedSlot& orig, DtReaderWriterRegistry* 
      parentRegistry = NULL);

   DtReservedSlot(const DtSymbolString& name, const 
      DtReservedSlot& orig, DtReaderWriterRegistry* 
      parentRegistry = NULL);

   virtual ~DtReservedSlot();

   int reservedSlot() const;
   void setReservedSlot(int);

   const DtRwTemplatedListPtr<DtRwString>& reservedBy() const;
   void addReservedBy(const DtString&);

protected:
   DtRwInt                          myReservedSlot;
   DtRwTemplatedListPtr<DtRwString> myReservedBy;
};

typedef std::map<int, DtReservedEmbarkationSlotEntry>   DtEmbarkationSlotEntryMap;
typedef std::vector<DtLoadPoint> DtLoadPathPoints;

class DT_DLL_vrfobjcore DtEmbarkationSlotManager : public DtReaderWriter
{
public:
   DtEmbarkationSlotManager(const DtString& name, DtReaderWriterRegistry* 
      parentRegistry = NULL);
   DtEmbarkationSlotManager(const DtSymbolString& name, DtReaderWriterRegistry* 
      parentRegistry = NULL);

   DtEmbarkationSlotManager(const DtString& name, const 
      DtEmbarkationSlotManager& orig, DtReaderWriterRegistry* 
      parentRegistry = NULL);

   DtEmbarkationSlotManager(const DtSymbolString& name, const 
      DtEmbarkationSlotManager& orig, DtReaderWriterRegistry* 
      parentRegistry = NULL);

   virtual ~DtEmbarkationSlotManager();

   virtual void addSlot(int iSlot, const DtEmbarkationSlotEntry*);
   virtual DtEmbarkationSlotInformation slotFor(const DtVrfObject* embarkingObject,
      const DtVrfObject* hostObject) const;

   virtual DtEmbarkationSlotInformation entityEmbarkationSlotInformation(const DtVrfObject*) const;

   virtual bool blocked(int iSlot) const;
   virtual void addSlotExclusion(const DtSlotExclusion&);

   virtual bool canEmbark(const DtEmbarkationSlotEntry*, const DtVrfObject*) const;

   virtual bool reserveSlot(int iSlot, const DtString&);

   virtual void addIngressPoint(const DtLoadPoint&);
   virtual void ingressPoints(int iSlot, const DtVrfObject* embarkingObject,
      const DtVrfObject* hostObject, DtEmbarkationSlotInformation& info) const;

   virtual void addEgressPoint(const DtLoadPoint&);
   virtual void egressPoints(int iSlot, DtEmbarkationSlotInformation& info) const;

   virtual void giveUpSlot(int, const DtString&);

   virtual DtEmbarkationSlotManager* clone(const DtString& name, DtReaderWriterRegistry* 
      parentRegistry = NULL);

   virtual void calculateDisembarkPositions(const std::list<DtString>&, DtSimManager*);

   virtual DtVector nextDisembarkPosition(const DtVrfObject* parent, const DtVrfObject* disembarking,
      const DtSimManager* simMgr, const DtVector& lastBodyPos, bool tasked);

   virtual void setScalingFactor(double);
   virtual double scalingFactor() const;

protected:
   virtual void calculateGridSize(const std::list<DtString>&, DtSimManager*);

   virtual void calculateGridCellSize(const std::list<DtString>&, DtSimManager*);

   virtual DtDcm finalPositionTransformationMatrix(const DtVrfObject* parent, const DtVector& lastBodyPos) const;

protected:
   virtual bool slotMatches(const DtLoadPoint*, int iSlot) const;

   virtual void putData(FILE *fp, int indentLevel = 0);

   virtual bool blocked(int iSlot, const DtSlotExclusion&) const;

   virtual const DtLoadPoint* bestIngressFor(const DtLoadPoint* ingressA, 
      const DtLoadPoint* ingressB, const DtVrfObject* embarkingObject,
      const DtVrfObject* hostObject) const;

   virtual DtVector bodyPositionToLocalPosition(const DtVector& bodyPosition,
      const DtVrfObject* body) const;

protected:
   DtEmbarkationSlotEntryMap              mySlots;
   DtRwTemplatedListPtr<DtLoadPoint>      myIngressPoints;
   DtRwTemplatedListPtr<DtLoadPoint>      myEgressPoints;
   DtRwTemplatedListPtr<DtSlotExclusion>  mySlotExclusions;

   DtRwVector                             myDisembarkGridSize;

   DtRwVector                             myDisembarkGridCellSize;

   DtRwInt                                myDisembarkGridCell;

   DtRwTemplatedListPtr<DtReservedSlot>   myReservedSlots;

   double                                 myScalingFactor;
};

inline int DtReservedSlot::reservedSlot() const
{
   return myReservedSlot;
}

inline void DtReservedSlot::setReservedSlot(int s)
{
   myReservedSlot = s;
}

inline void DtReservedSlot::addReservedBy(const DtString& s)
{
   myReservedBy.add(new DtRwString("reserved-by", s));
}

inline const DtRwTemplatedListPtr<DtRwString>& DtReservedSlot::reservedBy() const
{
   return myReservedBy;
}

#endif