VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ballisticGunControllerDescriptor.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2018 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
9 #pragma once
10 
12 #include <readerWriter/rwReal.h>
15 #include "vrfutil/simClock.h"
16 #include <readerWriter/rwInt.h>
21 
22 #include <tbb/spin_mutex.h>
23 
24 
29 {
30 public:
33  DtReaderWriterRegistry* parentRegistry = NULL);
34 
36  DtReaderWriterRegistry* parentRegistry = NULL);
37 
41  DtReaderWriterRegistry* parentRegistry = NULL);
42 
46 
49 
52  virtual DtString type() const;
53 
55  DtReaderWriterRegistry* parentRegistry = NULL) const;
56 
58 
59  virtual DtTime loadAmmoTime() const;
60  virtual void setLoadAmmoTime(DtTime loadTime);
62 
64 
65  virtual DtTime unloadAmmoTime() const;
66  virtual void setUnloadAmmoTime(DtTime unloadTime);
68 
70 
71  virtual int roundsPerTriggerPull() const;
72  virtual void setRoundsPerTriggerPull(int value);
74 
76 
77  virtual const DtAmmoSelectTable& ammoSelectTable() const;
78  virtual void setAmmoSelectTable(const DtAmmoSelectTable& table);
80 
82 
83  virtual const DtString& ammoSelectTableFilename();
84  virtual void setAmmoSelectTableFilename(const DtString& filename);
86 
88 
89  virtual DtTargetSelectionCriteria& targetSelectionCriteria();
90  virtual const DtTargetSelectionCriteria& targetSelectionCriteria() const;
92 
95 
96  virtual bool disabledBySuppression() const;
97  virtual void setDisabledBySuppression(const bool isDisabled);
99 
102  virtual bool treatSelectedAsTasked() const;
103  virtual void setTreatSelectedAsTasked(bool t);
105 
108  virtual const DtTargetingControlTable& targetingControlTable() const;
109  virtual DtTargetingControlTable& targetingControlTable();
111 
117  virtual DtString requiredTokensString() const;
118  virtual std::set<DtString> requiredTokens() const;
119  virtual void setRequiredTokensString(const DtString& tokens);
121 
124  virtual int gunPriority() const;
125  virtual void setGunPriority(const int p);
127 
129 
130  virtual const DtRwProperties& weaponProperties() const;
131  virtual DtRwProperties& weaponProperties();
133 
135  static DtComponentDescriptor* creator();
136 
139  virtual void postGetSelf();
140 
141 protected:
144 
145 protected:
149 
156 
164 
170 
176 
185 
192 
200 
201 
211 
224 
233 
240 
245 
247 
251  mutable std::set<DtString> myRequiredTokenSet;
252  mutable tbb::spin_mutex myRequiredTokensMutex;
253 };
DtRwString myRequiredTokens
Parameter Name: required-tokens Parameter Description: A list of strings that name the &quot;token resourc...
Definition: ballisticGunControllerDescriptor.h:223
This class allows one to collect and compare strings using an index number instead of having to do st...
Definition: symbolString.h:27
#define DT_DLL_vrfobjparam
This file is used to determine how to build.
Definition: vrfobjparamDefines.h:28
tbb::spin_mutex myRequiredTokensMutex
Definition: ballisticGunControllerDescriptor.h:252
virtual void postGetSelf()
Called after either version of getSelf (mtl or environment). Default is no-op.
DtRwBoolean myDisabledBySuppression
Parameter Name: disabled-by-suppression Parameter Description: A boolean that indicates if this weapo...
Definition: ballisticGunControllerDescriptor.h:199
DtTargetSelectionCriteria myTargetSelectionCriteria
Parameter Name: targeting-control Parameter Description: List of DtTargetSelectionCriteria objects...
Definition: ballisticGunControllerDescriptor.h:191
Description: Readable, Writable DtString Variable substitutions are done on this object when it is re...
Definition: rwString.h:20
A readable, writable type whose name is the name of a component and that has a list of component name...
Definition: componentDescriptor.h:49
DtRwTime myLoadAmmoTime
Parameter Name: load-ammo-time Parameter Description: The time delay from the time an ammo is selecte...
Definition: ballisticGunControllerDescriptor.h:155
Definition: readerWriterRegistry.h:39
DtTargetingControlTable myTargetingControlTable
Parameter Name: targeting-control-table Parameter Description: The table that will specify ammunition...
Definition: ballisticGunControllerDescriptor.h:239
DtComponentDescriptor & operator=(const DtComponentDescriptor &orig)
assignment
Defines a criteria for choosing targets for a single weapon system. This class stores all the informa...
Definition: targetSelectionCriteria.h:27
DtRwBoolean myTreatSelectedAsTasked
Parameter Name: treat-selected-target-as-tasked Parameter Description: a boolean that indicates that ...
Definition: ballisticGunControllerDescriptor.h:210
DtReaderWriterFile myAmmoSelectTableFile
Parameter Name: ammo-select-table-file Parameter Description: Sets the filename used for the ammo sel...
Definition: ballisticGunControllerDescriptor.h:169
DtRwInt myGunPriority
Parameter Name: gun-priority Parameter Description: A priority among all guns mounted on the same tur...
Definition: ballisticGunControllerDescriptor.h:232
File: vlClock.h.
Description: Readable, Writable int.
Definition: rwInt.h:25
DtRwTime myUnloadAmmoTime
Parameter Name: unload-ammo-time Parameter Description: The time is takes to remove ammo (of the wron...
Definition: ballisticGunControllerDescriptor.h:163
virtual DtComponentDescriptor * clone(DtReaderWriterRegistry *parentRegistry=NULL) const
DtAmmoSelectTable is a readable/writable list of DtAmmoSelectEntrys. It&#39;s sorted by the entity type i...
Definition: ammoSelectTable.h:27
Description: Readable, Writable DtReal (double)
Definition: rwReal.h:27
std::set< DtString > myRequiredTokenSet
The tokens in a set rather than a comma-separated list in one string. This is mutable because it is s...
Definition: ballisticGunControllerDescriptor.h:251
virtual DtString type() const
Returns the type of component this descriptor describes. Used to create the descriptor on read from a...
Description: Readable, Writable bool.
Definition: rwBoolean.h:26
static DtComponentDescriptor * creator()
DtAmmoSelectTable myAmmoSelectTable
Parameter Name: ammo-select-table Parameter Description: Table of target types versus lists of priori...
Definition: ballisticGunControllerDescriptor.h:175
A list of properties. A DtPropertyInterface object that is a specialized version of DtRwVariableBindi...
Definition: rwProperties.h:126
DtBallisticGunControllerDescriptor, descriptor for the DtBallisticGunController component.
Definition: ballisticGunControllerDescriptor.h:28
Using a DtReaderWriterFile allows a DtReaderWriter object to be read in from an MTL stream contained ...
Definition: readerWriterFile.h:35
DtRwInt myRoundsPerTriggerPull
Parameter Name: rounds-per-trigger-pull Parameter Description: The number of rounds to fire for each ...
Definition: ballisticGunControllerDescriptor.h:184
Definition: targetingControlTable.h:20
DtRwProperties myWeaponProperties
A flexible collection of static properties that are provided to users of the weapon through the weapo...
Definition: ballisticGunControllerDescriptor.h:244

Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)