VR-Forces 5.0.1 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
engagementReportGeneratorController.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2013 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
10 #pragma once
11 
14 #include <list>
17 
20 class DtRwEngagementInfo;
21 class DtEngagementReport;
22 class DtSimMessage;
23 class DtVrfObjectMessage;
24 class DtSettingsObject;
25 class DtBoolSetting;
26 class DtRwPropertiesList;
27 
47 {
48 private:
56 public:
57 
61  DtSimulationServices* simManager, DtComponentDescriptor* desc=0,
62  DtReaderWriterRegistry *parentRegistry=0);
63 
66 
70  virtual bool init();
71 
74  virtual const char* type() const;
75 
78  virtual void tick();
79 
81  static void setEngagementReportingCallback(DtSimMessage * msg, void * usr);
82 
83  virtual void processSetEngagementReporting(DtSimMessage * msg);
84 
88  virtual void setLocalEnabled(bool on);
89 
97  virtual void setGlobalEnabledOverridingLocal();
98 
102  static DtSimComponent * creator(const DtString& name,
103  DtLocalObject* owner,
104  DtSimulationServices* simManager,
105  DtComponentDescriptor* desc = 0,
106  DtReaderWriterRegistry* parentRegistry = 0);
107 
108 protected:
109 
112  DtEngagementReport* engagementReport();
113 
119  virtual bool createPSR();
120 
123  virtual void registerRadioMessageCallbacks();
124 
127  virtual void generateAndSendEngagementReport(const DtRwPropertiesList* attacks,
128  const DtRwPropertiesList* limitedMunitionAttacks,
129  const DtRwPropertiesList* attacksDefended);
130 
134  virtual DtRwEngagementInfo* createEngagementInfoForTarget(
135  const DtUUID& targetName, const DtSimObject* target);
136 
138  virtual void updateEngagementInfoForTarget(DtRwEngagementInfo& engagement,
139  const DtUUID& targetName, const DtSimObject* target,
140  bool engagementComplete = false);
141 
146  virtual void sendEngagementReport(bool superiorOnly);
147 
153  virtual bool engagementReportNeedsUpdateAndResend();
154 
161  virtual const DtSimReportMessageType& engagementReportTypeString() const;
162 
166  static void settingConsumerCallback(const DtSettingsObject* settingsObject,
167  void* usr);
170  virtual void readGlobalEnabledSetting(const DtBoolSetting* enabledSetting);
171 
176  virtual bool reportingEnabled() const;
177 
178 protected:
179 
182 
185 
189 
193 };
194 
DtEngagementReportGeneratorController is a controller that sends engagement reports based on the curr...
Definition: engagementReportGeneratorController.h:46
UUID is a unique ID wrapper class.
Definition: rwUUID.h:226
#define DT_DLL_vrfmodel
This file is used to determine how to build.
Definition: vrfmodelDefines.h:24
DtEngagementReportGeneratorControllerPSR * myProcessState
Container for state data associated with this component. This state is saved and restored as part of ...
Definition: engagementReportGeneratorController.h:188
const DtControllerComponent & operator=(const DtControllerComponent &orig)
assignment operator
Definition: boolSetting.h:30
virtual const char * type() const =0
This returns a string from compTypes.h, and identifies the type of component.
DtEngagementReport; subclass of DtSimReport.
Definition: engagementReport.h:26
Definition: vrfObjectMessageTypeTemplate.h:24
Process State Repository for DtEngagementReportGeneratorController.
Definition: engagementReportGeneratorControllerPSR.h:19
A readable, writable type whose name is the name of a component and that has a list of component name...
Definition: componentDescriptor.h:49
DtEngagementReportGeneratorControllerDescriptor; descriptor for the DtEngagementReportGeneratorContro...
Definition: engagementReportGeneratorControllerDescriptor.h:22
const DtEngagementReportGeneratorControllerDescriptor * myDescriptor
Pointer to this components descriptor.
Definition: engagementReportGeneratorController.h:184
Definition: readerWriterRegistry.h:39
virtual bool init()
Calls setRadio()
Definition: settingsObject.h:27
bool myGlobalEnabled
Holds a copy of the global engagement reports enabled setting. When the global value changes...
Definition: engagementReportGeneratorController.h:192
DtEngagementReport * myEngagementReport
The engagement report.
Definition: engagementReportGeneratorController.h:181
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 ...
Define constants for types of tasks, sets, admin messages, reports, and sim commands (all sent via ra...
The base class for all messages to/from a specific DtVrfObject. Various subclasses of this class will...
Definition: vrfObjectMessage.h:30
End User Description: DtControllerComponent is the base class for all controllers components...
Definition: controllerComponent.h:31
Central access point of all non-object-specific the services and managers that are available for use ...
Definition: simulationServices.h:89
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
Acts as a DtRwList for properties. Only real difference between this class and a DtRwProperties class...
Definition: rwPropertiesList.h:38
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
Contains information about an engagement against a single enemy.
Definition: rwEngagementInfo.h:23

Document ID: Generated on Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)