include/vrfmodel/aggregatedPatrolController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: aggregatedPatrolController.h,v $ $Revision: 1.2 $ $State: Exp $
*******************************************************************************/



#ifndef aggregatedPatrolController_H_
#define aggregatedPatrolController_H_

#include "vrfobjcore/singleTaskControllerComponent.h"
#include "vrfmodel/vrfmodelDefines.h"

class DtFormationState;
class DtAggregatedPatrolPSR;
class DtVrfObjectManager;

class DT_DLL_vrfmodel DtAggregatedPatrolController : public DtSingleTaskControllerComponent
{
public:

   enum DtPatrolAlongState
   {
      DtMovingAlongRoute = 0,
      DtReversingDirection = 1
   };

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

   virtual ~DtAggregatedPatrolController();

   virtual DtString type() const;

   virtual bool init();

   virtual void registerTaskMsgCallbacks();

   DtSimTaskStatePtr currentTaskState() const;

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

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

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

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

protected:

   virtual void onPatrolTwoPointsTask(DtSimMessage * msg, DtSimTaskStatePtr taskStatePtr);

   virtual void onTaskComplete(DtSimMessage * msg);

   virtual bool moveTo(const DtString& controlPointName);

   virtual void processPatrolAlongTask(DtSimMessage * msg, DtSimTaskStatePtr taskStatePtr);

   virtual bool createPSR();

   virtual DtIteratorDirection initialTraversalDirection(
      const DtString& routeName, const DtVector& initialWorldPosition) const;

   virtual void sendMoveAlongToSelf(const DtString& routeName,
      enum DtIteratorDirection traversalDirection, bool startAtClosestPoint);

private:

   DtAggregatedPatrolController(const DtAggregatedPatrolController& orig);

   DtAggregatedPatrolController& operator=(const DtAggregatedPatrolController& orig);
protected:

   DtAggregatedPatrolPSR* myProcessState;
};

#endif