include/vrfmodel/disaggregatedFormationController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 1999 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: disaggregatedFormationController.h,v $ $Revision: 1.1 $ $State: Exp $
*******************************************************************************/



#ifndef disaggregatedFormationController_H_
#define disaggregatedFormationController_H_

#include <vlutil/vlConfig.h> 
#include <vector>

#include "vrfobjcore/cntrlCmpnt.h"
#include "vrfobjcore/orgViewManagedObjList.h"
#include "vrfobjcore/cmdChanRadio.h"

class DtFormationControllerDescriptor;
class DtSimMessage;
class DtFormationState;
class DtVrfAggregateStateRepository;
class DtSubordinateManager;
class DtFormation;
class DtOrganizationManagerNode;
class DtSetDataRequest;
class DtSetDataManager;
class DtFormationPSR;
class DtAggregateObjectParameters;

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

public:

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

   virtual ~DtDisaggregatedFormationController();

   virtual bool init();

   virtual void tick();

   virtual DtString type() const;

   virtual void setRadio(DtSimBaseRadio * radio);

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

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

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

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

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

   static void subordinatesChangedCallback(DtEntityIdentifier entId, void* usr);

   static void nodeAddedCallback(DtEntityIdentifier eid, void* userData);
   virtual void processNodeAddedCallback(DtEntityIdentifier eid);

   virtual void enable();

   virtual void disable();

public:

   static void onTaskNotifyCallback(const DtSimTask & task, 
      const DtSimComponent &notifier, void* usr);

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

protected:

   virtual bool formationUpdateIsNeeded() const;

   virtual void processSetFormation(DtSimMessage * msg);

   virtual void processSetFormationType(DtSimMessage * msg);

   virtual void processSetHeading(DtSimMessage * msg);

   virtual void processSetLocation(DtSimMessage * msg);

   virtual void processSnapIntoFormation(DtSimMessage * msg); 

   virtual void processSubordinatesChanged(DtEntityIdentifier entId);

   virtual void snapIntoFormation(const DtString& formation, 
      const DtVector& location, double heading, bool applyHeading);

   virtual void getCurrentFormation(DtFormation& formation);

   virtual DtOrgViewManagedObjectListConstPtr generateListOfSubordinatesEligibleForFormation();

   virtual std::list<int> generateFormationPositions(DtOrgViewManagedObjectListConstPtr& entityInFormation);

   virtual int findPositionInVector(const std::vector<DtEntityIdentifier> subordinateList,
      const DtEntityIdentifier& entityId) const;

   virtual void generateFormationAtPositionAndOrientation(const DtVector& geocentricOrigin,
      const DtTaitBryan& geocentricOrientation, std::vector<DtVector> geocentricPositions, 
      DtFormation& formation);

   virtual void generateWorkingFormation(DtFormation& formation);

   virtual void updateFormationState();

   virtual void registerWithOrgManager();

   virtual void unregisterWithOrgManager();

   virtual void sendRequestToSelf(const DtSetDataRequest& request) const;

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

   virtual bool createPSR();

   virtual void processOnTaskNotifyCallback(const DtSimTask & task, 
      const DtSimComponent &notifier);

   static void requestAvailableFormationsCallback(const DtVrfObjectMessage* msg, void* usr);
   virtual void processRequestAvailableFormations(const DtVrfObjectMessage* msg);

   virtual void addSetDataCallbacks();

   void removeSetDataCallbacks();

protected:

   const DtFormationControllerDescriptor* myFormationControllerDescriptor;

   DtVrfAggregateStateRepository* myAggregateStateRepository;

   DtFormationState* myFormationState;

   bool myRegisteredWithOrgManager;

   DtCommandChannelRadio* myCommandChannelRadio;

   DtSetDataManager* mySetDataManager;

   DtFormationPSR* myProcessState;

   bool myFormationCallbacksAreDisabled;

   bool myFirstTick;

   bool myRegisteredForAddNodeCallback;

   const DtAggregateObjectParameters* myAggregateParameters;
};

#endif