VR-Forces 4.1 Class Documentation
vrfObjParams.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2004 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 /*******************************************************************************
6 ** $RCSfile: vrfObjParams.h,v $ $Revision: 1.45 $ $State: Exp $
7 *******************************************************************************/
8 
11 
14 
15 #ifndef DtVrfObjectParameters_H_
16 #define DtVrfObjectParameters_H_
17 
18 #include "vrfutil/rdrWritr.h"
19 #include "vrfutil/rwObjType.h"
20 #include "vrfutil/rwBndingVol.h"
21 #include "vrfobjparam/paramFact.h"
22 #include "vrfutil/rwFormType.h"
23 #include "vrfutil/rwBndGeomType.h"
24 #include "vrfutil/rwForce.h"
25 #include "vrfutil/rwReal.h"
26 #include "vrfutil/rwBoolean.h"
27 #include "vrfutil/rwString.h"
28 #include "vrfutil/vlClock.h"
29 #include "vrfutil/rwDRTypes.h"
30 #include "vrfobjparam/rwDeadReckonThresholds.h"
31 #include "vrfobjparam/compDescLst.h"
32 #include "vrfutil/subObjList.h"
33 #include "vrfobjparam/connDescList.h"
34 #include "vrfutil/rsrcMgr.h"
35 #include "vrfutil/rwSensorSignatureList.h"
36 #include "vrfobjparam/simSector.h"
37 #include "vrfobjparam/vrfRadioDescriptorList.h"
38 #include "vrfobjparam/compSystemDescriptorList.h"
39 #include <list>
40 #include "vrfutil/rwFile.h"
41 #include "vrfobjparam/taskExecutionRules.h"
42 
43 class DtSimResource;
44 class DtVrfObjectSubComponentTypes;
45 class DtFilename;
46 class DtVrfStateRepositoryUserExtension;
47 class DtRadioDescriptorList;
48 class DtSimArtPartDescriptor;
49 
54 #include "vrfobjparam/vrfobjparamDefines.h"
55 class DT_DLL_vrfobjparam DtVrfObjectParameters : public DtReaderWriter
56 {
57 
58 public:
60  DtVrfObjectParameters(const DtString& name = DtString::nullString(),
61  DtReaderWriterRegistry* parentRegistry = NULL);
62  DtVrfObjectParameters(const DtSymbolString& name,
63  DtReaderWriterRegistry* parentRegistry = NULL);
64 
66  virtual ~DtVrfObjectParameters();
67 
68 protected:
70  DtVrfObjectParameters(const DtVrfObjectParameters& orig,
71  const DtString& name = DtString::nullString(),
72  DtReaderWriterRegistry* parentRegistry = NULL);
73 
74  DtVrfObjectParameters(const DtVrfObjectParameters& orig,
75  const DtSymbolString& name,
76  DtReaderWriterRegistry* parentRegistry = NULL);
77 
78 public:
80  DtVrfObjectParameters& operator=(const DtVrfObjectParameters& orig);
81 
82  virtual DtVrfObjectParameters* clone(
83  const DtString& name = DtString::nullString(),
84  DtReaderWriterRegistry* parentRegistry = NULL) const;
85 
86  virtual DtVrfObjectParameters* clone(
87  const DtSymbolString& name,
88  DtReaderWriterRegistry* parentRegistry = NULL) const;
89 
95  virtual bool init();
96 
102  virtual DtString type() const;
103 
115  virtual bool inheritValues(const DtVrfObjectParameters * benefactor);
116 
117  virtual void inheritValuesFromThisType(
118  const DtVrfObjectParameters * benefactor);
119 
121  virtual bool createLocalSubComponentTypes();
122 
124  virtual bool createRemoteSubComponentTypes();
125 
130  virtual DtVrfObjectSubComponentTypes * localVrfSubComponentTypes() const;
131 
136  virtual DtVrfObjectSubComponentTypes * remoteVrfSubComponentTypes() const;
137 
140  virtual void setMinTickPeriod(DtReal minTickPeriod);
141 
144  virtual DtReal minTickPeriod() const;
145 
148  virtual void setMinTickPeriodVariance(DtReal minTickPeriodVariance);
149 
152  virtual DtReal minTickPeriodVariance() const;
153 
157  virtual DtForceType forceType() const;
158  virtual void setForceType(const DtForceType force);
159 
161  virtual const DtString& category() const;
162 
163  virtual void setCategory(const DtString& category);
164 
166  virtual bool categorySpecified() const;
167 
169  virtual const DtString& echelonLevel() const;
170 
171  virtual void setEchelonLevel(const DtString& echelonLevel);
172 
174  virtual bool echelonLevelSpecified() const;
175 
177  virtual bool organized() const;
178 
179  virtual void setOrganized(bool organized);
180 
182 
183  virtual const DtComponentSystemDescriptorList& systemDescriptorList() const;
184  virtual DtComponentSystemDescriptorList& systemDescriptorList();
185  virtual void setSystemDescriptorList(const DtComponentSystemDescriptorList& list);
187 
189  virtual const DtComponentDescriptorList& sensorDescriptorList() const;
190  virtual DtComponentDescriptorList& sensorDescriptorList();
191  virtual void setSensorDescriptorList(const DtComponentDescriptorList& list);
192 
194  virtual const DtComponentDescriptorList& controllerDescriptorList() const;
195  virtual DtComponentDescriptorList& controllerDescriptorList();
196  virtual void setControllerDescriptorList(const DtComponentDescriptorList&
197  list);
198 
200  virtual const DtComponentDescriptorList& actuatorDescriptorList() const;
201  virtual DtComponentDescriptorList& actuatorDescriptorList();
202  virtual void setActuatorDescriptorList(const DtComponentDescriptorList&
203  list);
204 
206  virtual const DtConnectionDescriptorList& connectionDescriptorList() const;
207  virtual DtConnectionDescriptorList& connectionDescriptorList();
208  virtual void setConnectionDescriptorList(const DtConnectionDescriptorList&
209  list);
210 
212  virtual DtDeadReckonTypes deadReckoningAlgorithm() const;
213  virtual void setDeadReckoningAlgorithm(DtDeadReckonTypes
214  deadReckoningAlgorithm);
215 
217 
218  virtual const DtRwBoolean deadReckoningAllowGuiOverrides() const;
219  virtual void setDeadReckoningAllowGuiOverrides(bool allow);
221 
223  virtual const DtRwDeadReckonThresholds& deadReckoningThresholds() const;
224  virtual void setDeadReckoningThresholds(const DtRwDeadReckonThresholds&
225  deadReckoningThresholds);
226 
228  virtual DtReal mass() const;
229  virtual void setMass(const DtReal mass);
230 
232 
233  virtual const DtRadioDescriptorList& radioDescriptorList() const;
234  virtual DtRadioDescriptorList& radioDescriptorList();
236 
238  virtual const DtRwSensorSignatureList& sensorSignatureList() const;
239  virtual DtRwSensorSignatureList& sensorSignatureList();
240 
244  virtual const DtVrfSubObjectParameterList& subordinateObjects() const;
245  virtual void setSubordinateObjects(
246  const DtVrfSubObjectParameterList& subordinateObjects);
247 
252  virtual const DtVrfSubObjectParameterList& attachedObjects() const;
253  virtual void setAttachedObjects(
254  const DtVrfSubObjectParameterList& attachedObjects);
255 
260  virtual DtVrfObjectSubComponentTypes * localSubComponentTypes() const;
261 
266  virtual DtVrfObjectSubComponentTypes * remoteSubComponentTypes() const;
267 
270  virtual void putData(FILE *fp, int indentLevel = 0);
271 
274  virtual DtlObjPtr getData(DtlObjPtr args, const DtFilename& searchPath,
275  const DtVariableBindingsList& variableBindings);
276 
278  virtual const Dt3dBoundingVolume * boundingVolume() const;
279 
281  virtual void setBoundingVolume(const Dt3dBoundingVolume& newBoundingVolume);
282 
288  virtual void setBoundingVolume(const DtVector& localBvolDiagonal,
289  const DtVector& offset = DtVector::zero());
290 
292  virtual DtSimBoundingGeometry::DtSimBoundingGeometryType
293  boundingGeometryType() const;
294  virtual void setBoundingGeometryType(
295  DtSimBoundingGeometry::DtSimBoundingGeometryType type);
296 
298  virtual DtAggregateFormation formation() const;
299  virtual void setFormation(DtAggregateFormation formation);
300 
302  virtual const DtString& engagementRules() const;
303  virtual void setEngagementRules(const DtString& engagementRules);
304 
306  virtual const DtSimResourceManager& resourceManager() const;
307  virtual void setResourceManager(const DtSimResourceManager& resourceManager);
308 
310  virtual void setStateRepositoryUserExtensionType(const DtString& type);
311  virtual const DtString& stateRepositoryUserExtensionType() const;
312 
314  virtual DtObjectType objectType() const;
315  virtual void setObjectType(const DtObjectType& objectType);
316 
323  virtual bool taskedBySuperiorUponTaskComplete() const;
324  virtual void setTaskedBySuperiorUponTaskComplete(bool trueOrFalse);
325 
326  static DtVrfObjectParameters * createParameters(DtlObjPtr mtlStream,
327  const DtFilename& searchPath, const DtVariableBindingsList& variableBindings);
328  static DtVrfObjectParameters * createParameters(const char* name);
329 
330  static DtVrfObjectParameterFactory * factory();
331 
332  static void setFactory(DtVrfObjectParameterFactory * factory);
333 
334  static void addParameterCreatorFcn(const DtString & type,
335  DtSimObjectParametersCreatorFcn fcn);
336 
338  static DtVrfObjectParameters * creator();
339 
341  void setParameterType(const DtString&);
342  const DtString& parameterType() const;
343 
346  virtual void setStateRepositoryUserExtension(
347  const DtVrfStateRepositoryUserExtension& userExtension);
348  virtual DtVrfStateRepositoryUserExtension* stateRepositoryUserExtension() const;
349 
353  virtual void getSelf(DtlObjPtr args, const DtFilename& searchPath =
354  DtFilename::nullFilename(),
355  const DtVariableBindingsList& variableBindings = nullVariableReference());
356 
360  virtual DtTime underFireTime() const;
361 
365  virtual void setUnderFireTime(DtTime time);
366 
370  virtual bool underFireTimeSpecified() const;
371 
375  virtual DtReal underFireDistance() const;
376 
380  virtual void setUnderFireDistance(DtReal underFireDistance);
381 
386  virtual bool underFireDistanceSpecified() const;
387 
389 
390  virtual const DtSimSector& initialSectorOfResponsibility() const;
391  virtual void setInitialSectorOfResponsibility(const DtSimSector& sor);
393 
395 
396  virtual DtTaskExecutionRules& taskExecutionRules();
397  virtual const DtTaskExecutionRules& taskExecutionRules() const;
399 
401 
402  virtual void setTaskExecutionRulesFilename(const DtFilename&);
403  virtual const DtReaderWriterFile& taskExecutionRulesFilename() const;
405 
410  virtual const std::list<DtSimArtPartDescriptor*>* completeArtPartList() const;
411 
412 protected:
413 
420  virtual DtVrfSubObjectParameterList* createSubordinateObjectsList(
421  const DtSymbolString& name, DtReaderWriterRegistry* parentRegistry) const;
422 
429  virtual DtVrfSubObjectParameterList* createAttachedObjectsList(
430  const DtSymbolString& name, DtReaderWriterRegistry* parentRegistry) const;
431 
434  virtual void rebuildArtPartList();
435 
439  virtual void addArtPartsFromSystem(DtComponentSystemDescriptor* systemDesc,
440  std::list<DtSimArtPartDescriptor*>& artPartList);
441 
442 protected:
443 
458  DtObjectType myObjectType;
459 
463 
475  DtRwBoundingGeometryType myBoundingGeometryType;
476 
488  DtRwBoundingVolume myBvol;
489 
494  DtVrfObjectSubComponentTypes * myLocalSubComponentTypes;
495 
500  DtVrfObjectSubComponentTypes * myRemoteSubComponentTypes;
501 
512  DtRwFormationType myFormationType;
513 
524  DtRwForceType myForceType;
525 
532  DtRwString myCategory;
533 
540  DtRwString myEchelonLevel;
541 
547  DtRwBoolean myOrganized;
548 
554  DtRwReal myMinTickPeriod;
555 
562  DtRwReal myMinTickPeriodVariance;
563 
576  DtRwDeadReckonTypes myDeadReckoningAlgorithm;
577 
586  DtRwDeadReckonThresholds myDeadReckoningThresholds;
587 
588  DtRwBoolean myDeadReckoningAllowGuiOverrides;
589 
592  DtRadioDescriptorList myRadioDescriptorList;
593 
598  DtComponentSystemDescriptorList mySystemDescriptorList;
599 
602  DtComponentDescriptorList mySensorDescriptorList;
603 
606  DtComponentDescriptorList myControllerDescriptorList;
607 
610  DtComponentDescriptorList myActuatorDescriptorList;
611 
640  DtConnectionDescriptorList myConnectionDescriptorList;
641 
646  DtRwReal myMass;
647 
651  DtRwSensorSignatureList mySensorSignatureList;
652 
682  DtVrfSubObjectParameterList* mySubordinateObjects;
683 
687  DtVrfSubObjectParameterList* myAttachedObjects;
688 
697  DtRwString myEngagementRules;
698 
714  DtSimResourceManager myResourceManager;
715 
722  DtRwString myStateRepositoryUserExtensionType;
723 
729  DtRwBoolean myTaskedBySuperiorUponTaskComplete;
730 
737  DtVrfStateRepositoryUserExtension* myStateRepositoryUserExtension;
738 
743  DtRwTime myUnderFireTime;
744 
749  DtRwReal myUnderFireDistance;
750 
758  DtSimSector myInitialSectorOfResponsibility;
759 
766  DtReaderWriterFile myTaskExecutionRulesFilename;
768 
771  DtTaskExecutionRules myTaskExecutionRules;
772 
775  DtString myParameterType;
776 
777  static DtVrfObjectParameterFactory * theFactory;
778 
783  std::list<DtSimArtPartDescriptor*> myCompleteArtPartList;
784 
785 };
786 
787 inline void DtVrfObjectParameters::setParameterType(const DtString& t)
788 {
789  myParameterType = t;
790 }
791 
792 inline const DtString& DtVrfObjectParameters::parameterType() const
793 {
794  return myParameterType;
795 }
796 
797 #endif
798 
Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)