VR-Forces 4.8 Class Documentation
 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  DtSimManager* 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  DtVrfObject* owner,
104  DtSimManager* 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 DtVrfObjectStateRepository* target);
136 
138  virtual void updateEngagementInfoForTarget(DtRwEngagementInfo& engagement,
139  const DtUUID& targetName, const DtVrfObjectStateRepository* 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:222
#define DT_DLL_vrfmodel
This file is used to determine how to build.
Definition: vrfmodelDefines.h:24
DtVrfObject is used to represent any type of simulated object (entities, aggregate, control objects) in a VR-Forces application.
Definition: vrfObject.h:215
DtEngagementReportGeneratorControllerPSR * myProcessState
Container for state data associated with this component.
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:42
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
Description: This repository holds all information that is common to all the forms of all entity/aggr...
Definition: vrfObjectStateRepository.h:87
virtual bool init()
Calls setRadio()
Definition: settingsObject.h:27
bool myGlobalEnabled
Holds a copy of the global engagement reports enabled setting.
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.
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.
Definition: vrfObjectMessage.h:30
End User Description: DtControllerComponent is the base class for all controllers components...
Definition: controllerComponent.h:29
The DtSimComponent class is the base class for the entire simulation model component hierarchy...
Definition: simComponent.h:67
Acts as a DtRwList for properties.
Definition: rwPropertiesList.h:38
The simulation engine is controlled by a single,top-level class called the Simulation Manager...
Definition: simManager.h:102
Contains information about an engagement against a single enemy.
Definition: rwEngagementInfo.h:23

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)