VR-Forces 5.0.2 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
railPathController.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2012 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
11 
12 #pragma once
13 
15 #include <matrix/vlVector.h>
17 #include "vrfutil/railSegment.h"
18 
19 #include <boost/shared_ptr.hpp>
20 
21 class DtRailPathTask;
24 class DtAsyncJobMapEntry;
25 
57 {
58 private:
65 
66 public:
67 
70  DtRailPathController(const DtString& name,
71  DtLocalObject* owner,
72  DtSimulationServices* simManager,
73  DtComponentDescriptor* desc = NULL,
74  DtReaderWriterRegistry* parentRegistry = NULL);
75 
76  virtual ~DtRailPathController();
77 
79  virtual bool init();
80 
86  virtual bool createPSR();
87 
88  virtual void preFirstTickInit();
89 
90  static void railTaskCallback(DtSimMessage* msg, void* usr, DtSimTaskStatePtr taskStatePtr);
91 
92  virtual DtSimTaskStatePtr currentTaskState() const;
93 
96  virtual const char* type() const;
97 
99  virtual void registerTaskMsgCallbacks();
100 
101  static void taskCompleteReportCallback(DtSimMessage* msg, void* usr);
102 
103  virtual void processTaskCompleteReport(DtSimMessage* msg);
104 
105  static void destinationChangedCallback(const DtLocalObject* obj, void* usrData);
106 
111  virtual void processDestinationChanged();
112 
116 
117  virtual void processSetLocationComplete();
119 
121  virtual void tick();
122 
123 protected:
124  virtual void processRailTask(const DtTaskMessage& msg, DtSimTaskStatePtr taskStatePtr);
125 
126  virtual void clearCurrentPath();
127  virtual bool setupPathFromRailList(DtRailSegmentList*, bool testRange = true);
128  virtual bool setupPathFromRoute(const DtSimObject* route, bool startClosestPoint, DtIteratorDirection traversalDirection);
129 
131  virtual bool isEntityCloseEnoughToRoad(
132  DtRailSegment* railSegment, double distance, double& actualDistSq) const;
133 
135  virtual bool isEntityOnRoad(DtRailSegment* railSegment) const;
136 
137  double maxSearchRadius(const DtVector& start, const DtVector& end);
138 
140  virtual bool setupPathToDestination(const DtVector& start, const DtVector& end);
141 
145  virtual void clearTask();
146 
147 public:
148 
152  static DtSimComponent * creator(const DtString& name,
153  DtLocalObject* owner,
154  DtSimulationServices* simManager,
155  DtComponentDescriptor* desc = 0,
156  DtReaderWriterRegistry* parentRegistry = 0);
157 
158 protected:
160  boost::shared_ptr<DtAsyncJobMapEntry> myPathJobEntry;
161 
165 
168 
170  boost::signals2::scoped_connection mySetLocationCompleteConnection;
171 };
172 
#define DT_DLL_vrfmodel
This file is used to determine how to build.
Definition: vrfmodelDefines.h:24
bool myDestinationChangedCallbackRegistered
Definition: railPathController.h:167
std::list< DtRailSegment * > DtRailSegmentList
Definition: railSegment.h:197
DtSimObjectReference myDestination
Bookkeeping for callback registration.
Definition: railPathController.h:169
virtual void registerTaskMsgCallbacks()
virtual void preFirstTickInit()
This function can be overridden to initialize a component before it is ticked for the first time...
DtRailSegment are segments entities can follow when using the rail movement system.
Definition: railSegment.h:23
This class provides a base class for all controllers that are capable of executing a DtSimTask...
Definition: singleTaskControllerComponent.h:20
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
virtual const char * type() const =0
Returns a string identifies the class type of component. Type values are defined in compTypes...
virtual bool init()
Calls setRadio()
DtRailPathControllerPSR * myProcessState
Container for state data associated with this component. This state is saved and restored as part of ...
Definition: railPathController.h:164
virtual void clearTask()
If component is currently tasked, calls clearPendingSubtasks(), sets the tasked flag to false...
DtBoost::shared_ptr< DtSimTaskState > DtSimTaskStatePtr
Definition: taskAndTaskStateDefines.h:18
DtRailPathControllerDescriptor; descriptor for the DDtRailPathController component.
Definition: railPathControllerDescriptor.h:23
DtIteratorDirection
Definition: iteratorBase.h:23
const DtRailPathControllerDescriptor * myPathDescriptor
Definition: railPathController.h:166
DT_DLL_VRVCORE double distance(const makVrv::DtCoordinateSystem &, const DtVector &from, const DtVector &to)
Returns the distance from the two points. Coordinates are in local database coordinates The coordinat...
File: simMsg.h.
Definition: simMessage.h:35
virtual void tick()
This gives the thread of control to the component. The component is ticked once each simulation from ...
virtual DtSimTaskStatePtr currentTaskState() const
class DtRailPathControllerPSR:
Definition: railPathControllerPSR.h:27
DtRailPathController is a controller that models movement along a generated path for an entity making...
Definition: railPathController.h:56
Handle to async job.
Definition: asyncJobMapEntry.h:29
boost::shared_ptr< DtAsyncJobMapEntry > myPathJobEntry
Token for asynchronous path plan task.
Definition: railPathController.h:160
Central access point of all non-object-specific the services and managers that are available for use ...
Definition: simulationServices.h:90
The DtSimComponent class is the base class for the entire simulation model component hierarchy...
Definition: simComponent.h:70
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:79
const DtTaskControllerComponent & operator=(const DtTaskControllerComponent &orig)
assignment operator
File: railPathTask.h.
Definition: railPathTask.h:45
A DtTaskMsg is a DtRadioMsg with a pointer to a task. The type of the taskMsg is just the type of the...
Definition: taskMessage.h:21
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
boost::signals2::scoped_connection mySetLocationCompleteConnection
Definition: railPathController.h:170

Document ID: Generated on Sun Dec 4 20:22:03 EST 2022 from SVN revision 249613
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)