VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
occupancyDirectorController.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2015 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
11 #pragma once
12 
16 
17 #include <list>
18 
21 class DtSimMessage;
24 
43 {
44 public:
45 
49  DtLocalObject* owner,
50  DtSimulationServices* simManager,
51  DtComponentDescriptor* desc = 0,
52  DtReaderWriterRegistry* parentRegistry = 0);
53 
56 
58  virtual bool init();
59 
62  virtual const char* type() const;
63 
67  static DtSimComponent * creator(const DtString& name,
68  DtLocalObject* owner,
69  DtSimulationServices* simManager,
70  DtComponentDescriptor* desc = 0,
71  DtReaderWriterRegistry* parentRegistry = 0);
72 
73 protected:
74  static void requestEmbarkationInformationCallback(DtSimMessage* msg, void* usr);
75  virtual void processRequestEmbarkationInformation(DtSimMessage* msg);
76 
77  static void requestEmbarkationSlotInformationCallback(DtSimMessage* msg, void* usr);
78  virtual void processRequestEmbarkationSlotInformation(DtSimMessage* msg);
79 
80  static void requestEmbarkationEgressPointsCallback(DtSimMessage* msg, void* usr);
81  virtual void processRequestEmbarkationEgressPoints(DtSimMessage* msg);
82 
83 protected:
85  virtual void registerTaskMsgCallbacks();
86 
89  virtual void preFirstTickInit();
90 
92  virtual void tick();
93 
99  virtual bool createPSR();
100 
102  virtual void giveUpSlot(int iSlot, const DtUUID&);
103 
105  virtual DtEmbarkationSlotInformation embarkationSlotEntryFor(const DtUUID&) const;
106  virtual DtEmbarkationSlotInformation embarkationSlotEntryFor(int slot, const DtUUID&) const;
107 
109  virtual DtEmbarkationSlotInformation embarkationSlotEntryFor(const DtString& slotName, const DtString& slotType, const DtUUID&) const;
110 
113  virtual DtEmbarkationSlotInformation disembarkationInformationFor(const DtUUID&, int& iResult) const;
114 
116  virtual int disembarkationResult(const DtEmbarkationSlotInformation&) const;
117 
120  virtual bool reserveSlot(const DtEmbarkationSlotInformation& entry, const DtUUID&);
121 
124  virtual void sendSlotInformationTo(const DtUUID&,
125  const DtEmbarkationSlotInformation& entry, int, bool forEmbarkation, int reqId = 0xFFFFFFFF);
126 
131  virtual void processDisembarkAllTask(DtSimMessage* msg);
132  static void disembarkAllTaskCallback(DtSimMessage* msg, void* usr);
133 
135  virtual bool objectDisembarked(const DtUUID&);
139  virtual void disembarkNextObject();
140 
142  virtual void sendTask(const DtSimTask& task, const DtUUID&);
143 
145  static void disembarkObjectCallback(DtSimMessage* msg, void* usr);
148  virtual void processDisembarkObjectCallback(DtSimMessage* msg);
149 
161  virtual DtVector disembarkedPositionFor(const DtUUID&, const DtEmbarkationSlotInformation&) const;
162 
165  virtual bool nextEntityCanDisembark(const DtSimObject* curEntity) const;
166 
168  virtual bool isValidForDisembarkLayout(const DtSimObject*) const;
169 
171  virtual bool createCollisionDetector();
172 
174  virtual void setObstructionIDsInCollisionDetector();
175 
176 protected:
180  virtual void setupSlots();
181 
184  virtual void initializeSlotManager();
185 
188  virtual void calculateDisembarkPositions(const std::vector<DtSimObjectReference>&);
189 
192  virtual void generateListForDisembarkation(const std::vector<DtSimObjectReference>& list);
193 
195  virtual void removeAllSubordinates(DtSimObjectReference obj);
196 
198  virtual void processSimObjectDeleted(DtSimObjectReference);
199 
202  virtual void getDisembarkableObjects(std::vector<DtSimObjectReference>& objects);
203 
204 private:
205 
208 
211  orig);
212 
216 
217 protected:
218 
222 
226 
229  std::set<DtString> myObjectsToDisembark;
230 
231  boost::signals2::scoped_connection mySimObjectDeletedConnection;
232 };
UUID is a unique ID wrapper class.
Definition: uuid.h:59
#define DT_DLL_vrfmodel
This file is used to determine how to build.
Definition: vrfmodelDefines.h:24
virtual const char * type() const override=0
Returns a string identifies the class type of component. Type values are defined in compTypes...
Class DtOccupancyDirectorDescriptor is a DtComponentDescriptor that has parameters that configure the...
Definition: occupancyDirectorDescriptor.h:33
virtual void registerTaskMsgCallbacks()
Definition: embarkationSlotManager.h:92
virtual void preFirstTickInit()
This function can be overridden to initialize a component before it is ticked for the first time...
This class provides a base class for all controllers that are capable of executing a DtSimTask...
Definition: singleTaskControllerComponent.h:22
The DtSimObjectReference is a shared pointer that can be used amongst many object for access to the u...
Definition: simObjectReference.h:26
A readable, writable type whose name is the name of a component and that has a list of component name...
Definition: componentDescriptor.h:49
Definition: readerWriterRegistry.h:39
DtCollisionDetector * myCollisionDetector
Definition: occupancyDirectorController.h:225
Definition: embarkationSlotManager.h:39
DtEmbarkationSlotEntry.
Definition: embarkationSlotEntry.h:27
const DtOccupancyDirectorDescriptor * myOccupancyDirectorDescriptor
Definition: occupancyDirectorController.h:223
virtual bool init() override
Calls setRadio()
File: simMsg.h.
Definition: simMessage.h:35
class DtVrfOccupancyDirectorPSR:
Definition: vrfOccupancyDirectorPSR.h:28
virtual void tick()
This gives the thread of control to the component. The component is ticked once each simulation from ...
DtEmbarkationSlotManager * mySlotManager
Definition: occupancyDirectorController.h:224
boost::signals2::scoped_connection mySimObjectDeletedConnection
Definition: occupancyDirectorController.h:231
The DtCollisionDetector is a class used to detect collisions between a specified list of obstructions...
Definition: collisionDetector.h:54
DtOccupancyDirectorController allocates reserved embarkation slots and determines which (if any) obje...
Definition: occupancyDirectorController.h:42
Central access point of all non-object-specific the services and managers that are available for use ...
Definition: simulationServices.h:95
The DtSimComponent class is the base class for the entire simulation model component hierarchy...
Definition: simComponent.h:91
Represents a single simulation object in the exercise. Object may be VRF simulation, or non-VRF simulated, and may be simulated by the local sim engine, or by a remote sim engine. Only public (external) state of the object is available. All data is read-only. All access to data of the object is thread safe within the simulation frame.
Definition: simObject.h:88
const DtTaskControllerComponent & operator=(const DtTaskControllerComponent &orig)
assignment operator
DtVrfOccupancyDirectorPSR * myProcessState
Container for state data associated with this component. This state is saved and restored as part of ...
Definition: occupancyDirectorController.h:221
DtSimTask is an abstract base class from which real tasks can derive. It manages the read/write capab...
Definition: simTask.h:30
std::set< DtString > myObjectsToDisembark
Variable to control which units were disembarked by a superior to avoid multi messages.
Definition: occupancyDirectorController.h:229
A locally simulated VRF object. Holds all internal and external data for the object, and provides access to both the current frame and next frame state data for the object. All current frame data is read-only, and next-frame data can be written to. No thread safety guarantees are made on this object during the simulation frame and it should only be accessed by the thread that is simulating the object.
Definition: localObject.h:86

Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)