include/vrfmodel/convoyTaskController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2010 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: convoyTaskController.h,v $ $Revision: 1.0 $ $State: Exp $
*******************************************************************************/



#ifndef convoyTaskController_H_
#define convoyTaskController_H_

#include "vrfmodel/vrfmodelDefines.h"
#include "vrfobjcore/convoyPSR.h"
#include "vrfobjcore/singleTaskControllerComponent.h"
#include "vrfobjparam/convoyDescriptor.h"
#include "vrftasks/setDataReq.h"
#include "vrfutil/rwRailSegment.h"
#include "vrfutil/rwReal.h"
#include "vrfutil/rwTemplatedList.h"
#include "terrainCS/coordSystem.h"

class DtVrfObjectMessage;

class DT_DLL_vrfmodel DtConvoyTaskController : public DtSingleTaskControllerComponent
{
public:
   DtConvoyTaskController(const DtString& name, 
      DtVrfObject* owner,
      DtSimManager* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual ~DtConvoyTaskController();

   virtual bool init();

   virtual DtString type() const;

   virtual void clearTask();
 
   virtual void registerTaskMsgCallbacks();

   static void convoyTaskCallback(DtSimMessage * msg, void * usr);

   static void taskCompleteReportCallback(const DtVrfObjectMessage* msg, void * usr);

   static void destinationChangedCallback(DtVrfObject* obj, void* usr);

   static void objectAboutToBeRemovedCallback(DtVrfObject* obj, void* usr);

   static DtSimComponent * creator(const DtString& name, 
      DtVrfObject* owner,
      DtSimManager* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual void tick();

   virtual bool createPSR();

protected:
   void onObjectAboutToBeRemoved(DtVrfObject* obj);

   virtual void onModifyVrfObject(DtVrfObject* obj);

   virtual void onConvoyTask(DtSimMessage * msg);

   virtual void onTaskComplete(const DtVrfObjectMessage* msg);

   virtual void sendTaskToSubordinate(const DtSimTask& task, 
      const DtString& subordinateObjectName);

   virtual void sendSetToSubordinate(DtSetDataRequest& request,
      const DtString& subordinateObjectName);

   virtual bool setupTask(const DtVrfObject* aggregate, const DtVrfObject* destination, 
      bool pathPlan, const Coordinate_System* coordSys);

   virtual DtVector findAssemblyPoint(const DtVrfObject* aggregate, const DtVector& destination, 
      bool haveRails, const Coordinate_System* coordSys);

   virtual DtRwRailSegment* createEntrySegment(const DtVrfObject* entity, 
      const DtVector& assemblyPoint, const Coordinate_System* coordSys) const;

   virtual bool setupSubordinates(const DtVrfObject* aggregate, bool clearSubs, bool leaderSet = false);

   virtual void setupLeadOnDistance(int numberOfEntities, float distanceBetween);

   virtual bool createRailPath(const DtVrfObject* leadEntity, const DtVrfObject* destination,
      bool pathPlan, const Coordinate_System* coordSys);

   virtual bool areSeparationDistancesWithinRange(const DtConvoyPSR::DtRwSubordinateList& subordinates, 
      const float distance, const float tolerance, const Coordinate_System* coordSys);

   virtual void setLeaderSpeed(const float speed);

   virtual void resettingPhaseTick(bool retask = true);

   virtual void startingPhaseTick();

   virtual void assemblingPhaseTick();

   virtual void convoyingPhaseTick();

   virtual void finishingPhaseTick();

   virtual DtVector findIntersectionOfLineAndCircle(const DtVector& centerPoint, 
      const DtVector& endPoint, double radius, const Coordinate_System* coordSys) const;

   virtual bool getEntityToPathEntry(const DtVrfObject* entity, const DtVector& assemblyPoint,
      const Coordinate_System* coordSys);

   virtual DtRailSegment* findClosestEntryRail(const DtVrfObject* aggregate, 
      const double& radius,
      DtRailSegmentList* rails,
      int& railNumber,
      const Coordinate_System* coordSys) const;

   virtual bool isPointWithinRadius(const DtVector& center, double radius, 
      const DtVector& point, const Coordinate_System* coordSys) const;

   virtual bool findPointOnRailOutsideSphere(const DtVector& center, const double& radius, 
      const DtRailSegment* segment, DtVector& resultPoint, const Coordinate_System* coordSys) const;

   virtual void registerDestinationChangedCallback();
   
   virtual void unregisterDestinationChangedCallback();

   virtual bool updateConvoySubordinates(DtVrfObject* aggregate,
      std::vector<DtString>& tempList, 
      bool recursive = false);

   virtual bool isEntityPartOfConvoy(const DtString& name) const;

   virtual bool isEntityIndependentlyTasked(const DtVrfObject* entity) const;

   virtual void setConvoyFollowing();

   virtual void destroyedPhaseTick();

private:

   DtConvoyTaskController(const DtConvoyTaskController& orig);

   DtConvoyTaskController& operator=(const DtConvoyTaskController& orig);

   const DtConvoyDescriptor* myDescriptor;
   DtConvoyPSR* myProcessState;
   bool myDestinationChangedCallbackRegistered;
};

#endif