railPathController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2012 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/



#pragma once

#include "vrfobjcore/singleTaskControllerComponent.h"
#include <matrix/vlVector.h>
#include "vrftasks/setDataRequest.h"
#include "vrfutil/railSegment.h"

#include <boost/shared_ptr.hpp>

class DtRailPathTask;
class DtRailPathControllerPSR;
class DtRailPathControllerDescriptor;
class DtAsyncJobMapEntry;

#include "vrfmodel/vrfmodelDefines.h"
class DT_DLL_vrfmodel DtRailPathController : public DtSingleTaskControllerComponent
{
private:
   DtRailPathController();
   DtRailPathController(const DtRailPathController& orig);
   DtRailPathController& operator=(const DtRailPathController& orig);

public:

   DtRailPathController(const DtString& name, 
      DtVrfObject* owner,
      DtSimManager* simManager, 
      DtComponentDescriptor* desc = NULL,
      DtReaderWriterRegistry* parentRegistry = NULL);

   virtual ~DtRailPathController();

   virtual bool init();

   virtual bool createPSR();

   virtual void preFirstTickInit();

   static void railTaskCallback(DtSimMessage* msg, void* usr, DtSimTaskStatePtr taskStatePtr);

   virtual DtSimTaskStatePtr currentTaskState() const;

   virtual const char* type() const;

   virtual void registerTaskMsgCallbacks();

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

   virtual void processTaskCompleteReport(DtSimMessage* msg);

   static void destinationChangedCallback(const DtVrfObject* obj, void* usrData);

   virtual void processDestinationChanged(const DtVrfObject* obj);


   static void objectAboutToBeRemovedCallback(const DtVrfObject* obj, void* usr);
   virtual void processObjectAboutToBeRemoved(const DtVrfObject* obj);


   static void setLocationCompleteCallback(const DtVrfObject*, void* usr);
   virtual void processSetLocationComplete();

   virtual void tick();

protected:
   virtual void processRailTask(const DtTaskMessage& msg, DtSimTaskStatePtr taskStatePtr);

   virtual void clearCurrentPath();
   virtual bool setupPathFromRailList(DtRailSegmentList*, bool testRange = true);
   virtual bool setupPathFromRoute(const DtVrfObject* route, bool startClosestPoint, DtIteratorDirection traversalDirection);

   virtual bool isEntityCloseEnoughToRoad(
      DtRailSegment* railSegment, double distance, double& actualDistSq) const;

   virtual bool isEntityOnRoad(DtRailSegment* railSegment) const;

   double maxSearchRadius(const DtVector& start, const DtVector& end);

   virtual void registerDestinationChangedCallback();

   virtual void unregisterDestinationChangedCallback();

   virtual const DtVrfObject* publishDebugPath(DtRailSegmentList*);

   virtual void removeDebugPath();

   virtual bool setupPathToDestination(const DtVector& start, const DtVector& end);

   virtual void clearTask();

   static void destinationDiscovered(void*);
   virtual void processDestinationDiscovered();

public:

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

protected:
   boost::shared_ptr<DtAsyncJobMapEntry> myPathJobEntry;

   DtRailPathControllerPSR* myProcessState;

   const DtRailPathControllerDescriptor* myPathDescriptor;
   bool myDestinationChangedCallbackRegistered; 
};