VR-Forces 4.3.1 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
vrfObjectParameters.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2013 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
11 
12 #pragma once
13 
14 #include "vrfutil/readerWriter.h"
15 #include "vrfutil/rwObjectType.h"
16 #include "vrfutil/rwBoundingVolume.h"
17 #include "vrfobjparam/vrfObjectParameterFactory.h"
18 #include "vrfutil/rwFormationType.h"
19 #include "vrfutil/rwBoundingGeometryType.h"
20 #include "vrfutil/rwForceType.h"
21 #include "vrfutil/rwReal.h"
22 #include "vrfutil/rwBoolean.h"
23 #include "vrfutil/rwAppearance.h"
24 #include "vrfutil/rwString.h"
25 #include "vrfutil/simClock.h"
26 #include "vrfutil/rwDeadReckonTypes.h"
27 #include "vrfobjparam/rwDeadReckonThresholds.h"
28 #include "vrfobjparam/componentDescriptorList.h"
29 #include "vrfutil/vrfSubObjectParameterList.h"
30 #include "vrfobjparam/connectionDescriptorList.h"
31 #include "vrfutil/simResourceManager.h"
32 #include "vrfutil/rwSensorSignatureList.h"
33 #include "vrfobjparam/simSector.h"
34 #include "vrfobjparam/radioDescriptorList.h"
35 #include "vrfobjparam/componentSystemDescriptorList.h"
36 #include <list>
37 #include "vrfutil/readerWriterFile.h"
38 #include "vrfobjparam/taskExecutionRules.h"
39 #include "vrfutil/rwAutoConnection.h"
40 #include "vrfutil/rwProperties.h"
41 
42 class DtSimResource;
43 class DtVrfObjectSubComponentTypes;
44 class DtFilename;
45 class DtVrfStateRepositoryUserExtension;
46 class DtRadioDescriptorList;
47 class DtSimArtPartDescriptor;
48 
53 #include "vrfobjparam/vrfobjparamDefines.h"
54 class DT_DLL_vrfobjparam DtVrfObjectParameters : public DtReaderWriter
55 {
56 
57 public:
58  typedef DtRwTemplatedListPtr<DtRwAutoConnection,true> DtAutoConnectionsListPtr;
59 
61  DtVrfObjectParameters(const DtString& name = DtString::nullString(),
62  DtReaderWriterRegistry* parentRegistry = NULL, DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);
63  DtVrfObjectParameters(const DtSymbolString& name,
64  DtReaderWriterRegistry* parentRegistry = NULL, DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);
65 
67  virtual ~DtVrfObjectParameters();
68 
69 protected:
71  DtVrfObjectParameters(const DtVrfObjectParameters& orig,
72  const DtString& name = DtString::nullString(),
73  DtReaderWriterRegistry* parentRegistry = NULL);
74 
75  DtVrfObjectParameters(const DtVrfObjectParameters& orig,
76  const DtSymbolString& name,
77  DtReaderWriterRegistry* parentRegistry = NULL);
78 
79 public:
81  DtVrfObjectParameters& operator=(const DtVrfObjectParameters& orig);
82 
83  virtual DtVrfObjectParameters* clone(
84  const DtString& name = DtString::nullString(),
85  DtReaderWriterRegistry* parentRegistry = NULL) const;
86 
87  virtual DtVrfObjectParameters* clone(
88  const DtSymbolString& name,
89  DtReaderWriterRegistry* parentRegistry = NULL) const;
90 
96  virtual bool init();
97 
103  virtual DtString type() const;
104 
116  virtual bool inheritValues(const DtVrfObjectParameters * benefactor);
117 
118  virtual void inheritValuesFromThisType(
119  const DtVrfObjectParameters * benefactor);
120 
122  virtual bool createLocalSubComponentTypes();
123 
125  virtual bool createRemoteSubComponentTypes();
126 
131  virtual DtVrfObjectSubComponentTypes * localVrfSubComponentTypes() const;
132 
137  virtual DtVrfObjectSubComponentTypes * remoteVrfSubComponentTypes() const;
138 
141  virtual void setMinTickPeriod(DtReal minTickPeriod);
142 
145  virtual DtReal minTickPeriod() const;
146 
149  virtual void setMinTickPeriodVariance(DtReal minTickPeriodVariance);
150 
153  virtual DtReal minTickPeriodVariance() const;
154 
158  virtual DtForceType forceType() const;
159  virtual void setForceType(const DtForceType force);
160 
162  virtual const DtString& category() const;
163 
164  virtual void setCategory(const DtString& category);
165 
167  virtual bool categorySpecified() const;
168 
170  virtual const DtString& echelonLevel() const;
171 
172  virtual void setEchelonLevel(const DtString& echelonLevel);
173 
175  virtual bool echelonLevelSpecified() const;
176 
178  virtual bool organized() const;
179 
180  virtual void setOrganized(bool organized);
181 
183 
184  virtual const DtComponentSystemDescriptorList& systemDescriptorList() const;
185  virtual DtComponentSystemDescriptorList& systemDescriptorList();
186  virtual void setSystemDescriptorList(const DtComponentSystemDescriptorList& list);
188 
190  virtual const DtComponentDescriptorList& sensorDescriptorList() const;
191  virtual DtComponentDescriptorList& sensorDescriptorList();
192  virtual void setSensorDescriptorList(const DtComponentDescriptorList& list);
193 
195  virtual const DtComponentDescriptorList& controllerDescriptorList() const;
196  virtual DtComponentDescriptorList& controllerDescriptorList();
197  virtual void setControllerDescriptorList(const DtComponentDescriptorList&
198  list);
199 
201  virtual const DtComponentDescriptorList& actuatorDescriptorList() const;
202  virtual DtComponentDescriptorList& actuatorDescriptorList();
203  virtual void setActuatorDescriptorList(const DtComponentDescriptorList&
204  list);
205 
207  virtual const DtConnectionDescriptorList& connectionDescriptorList() const;
208  virtual DtConnectionDescriptorList& connectionDescriptorList();
209  virtual void setConnectionDescriptorList(const DtConnectionDescriptorList&
210  list);
211 
213  virtual DtDeadReckonTypes deadReckoningAlgorithm() const;
214  virtual void setDeadReckoningAlgorithm(DtDeadReckonTypes
215  deadReckoningAlgorithm);
216 
218 
219  virtual const DtRwBoolean deadReckoningAllowGuiOverrides() const;
220  virtual void setDeadReckoningAllowGuiOverrides(bool allow);
222 
224  virtual const DtRwDeadReckonThresholds& deadReckoningThresholds() const;
225  virtual void setDeadReckoningThresholds(const DtRwDeadReckonThresholds&
226  deadReckoningThresholds);
227 
229  virtual DtReal mass() const;
230  virtual void setMass(const DtReal mass);
231 
233 
234  virtual const DtRadioDescriptorList& radioDescriptorList() const;
235  virtual DtRadioDescriptorList& radioDescriptorList();
237 
239  virtual const DtRwSensorSignatureList& sensorSignatureList() const;
240  virtual DtRwSensorSignatureList& sensorSignatureList();
241 
245  virtual const DtVrfSubObjectParameterList& subordinateObjects() const;
246  virtual void setSubordinateObjects(
247  const DtVrfSubObjectParameterList& subordinateObjects);
248 
253  virtual const DtVrfSubObjectParameterList& attachedObjects() const;
254  virtual void setAttachedObjects(
255  const DtVrfSubObjectParameterList& attachedObjects);
256 
261  virtual DtVrfObjectSubComponentTypes * localSubComponentTypes() const;
262 
267  virtual DtVrfObjectSubComponentTypes * remoteSubComponentTypes() const;
268 
271  virtual void putData(FILE *fp, int indentLevel = 0);
272 
275  virtual DtlObjPtr getData(DtlObjPtr args,
276  const DtReaderWriter::SearchPaths& searchPaths,
277  const DtVariableBindingsList& variableBindings);
278 
280  virtual const Dt3dBoundingVolume * boundingVolume() const;
281 
283  virtual void setBoundingVolume(const Dt3dBoundingVolume& newBoundingVolume);
284 
290  virtual void setBoundingVolume(const DtVector& localBvolDiagonal,
291  const DtVector& offset = DtVector::zero());
292 
294  virtual DtSimBoundingGeometry::DtSimBoundingGeometryType
295  boundingGeometryType() const;
296  virtual void setBoundingGeometryType(
297  DtSimBoundingGeometry::DtSimBoundingGeometryType type);
298 
301  virtual double draft() const;
302 
304  virtual DtAggregateFormation formation() const;
305  virtual void setFormation(DtAggregateFormation formation);
306 
308  virtual DtU32 appearance() const;
309  virtual void setAppearance(const DtU32 appearance);
310  virtual bool appearanceSpecified() const;
311 
313  virtual const DtString& displayName() const;
314  virtual void setDisplayName(const DtString& s);
315 
317  virtual const DtString& displayDescription() const;
318  virtual void setDisplayDescription(const DtString& s);
319 
321  virtual const DtString& engagementRules() const;
322  virtual void setEngagementRules(const DtString& engagementRules);
323 
325  virtual const DtSimResourceManager& resourceManager() const;
326  virtual void setResourceManager(const DtSimResourceManager& resourceManager);
327 
329  virtual void setStateRepositoryUserExtensionType(const DtString& type);
330  virtual const DtString& stateRepositoryUserExtensionType() const;
331 
333  virtual DtObjectType objectType() const;
334  virtual void setObjectType(const DtObjectType& objectType);
335 
337  virtual DtObjectType matchType() const;
338  virtual void setMatchType(const DtObjectType& objectType);
339 
346  virtual bool taskedBySuperiorUponTaskComplete() const;
347  virtual void setTaskedBySuperiorUponTaskComplete(bool trueOrFalse);
348 
350  virtual void setRangeRingPublisherTickTime(double);
351  virtual double rangeRingPublisherTickTime() const;
352 
353  static DtVrfObjectParameters * createParameters(DtlObjPtr mtlStream,
354  const DtReaderWriter::SearchPaths& searchPaths, const DtVariableBindingsList& variableBindings,
355  DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);
356  static DtVrfObjectParameters * createParameters(const char* name,
357  DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);
358 
359  static DtVrfObjectParameterFactory * factory();
360 
361  static void setFactory(DtVrfObjectParameterFactory * factory);
362 
363  static void addParameterCreatorFcn(const DtString & type,
364  DtSimObjectParametersCreatorFcn fcn);
365 
367  static DtVrfObjectParameters * creator(DtEnvironmentSP env, DtEnvValueSP* objectNode);
368 
370  void setParameterType(const DtString&);
371  const DtString& parameterType() const;
372 
375  virtual void setStateRepositoryUserExtension(
376  const DtVrfStateRepositoryUserExtension& userExtension);
377  virtual DtVrfStateRepositoryUserExtension* stateRepositoryUserExtension() const;
378 
382  virtual void getSelf(DtlObjPtr args,
383  const DtReaderWriter::SearchPaths& searchPaths = DtReaderWriter::SearchPaths(),
384  const DtVariableBindingsList& variableBindings = nullVariableReference());
385 
389  virtual DtTime underFireTime() const;
390 
394  virtual void setUnderFireTime(DtTime time);
395 
399  virtual bool underFireTimeSpecified() const;
400 
404  virtual DtReal underFireDistance() const;
405 
409  virtual void setUnderFireDistance(DtReal underFireDistance);
410 
415  virtual bool underFireDistanceSpecified() const;
416 
418 
419  virtual const DtSimSector& initialSectorOfResponsibility() const;
420  virtual void setInitialSectorOfResponsibility(const DtSimSector& sor);
422 
424 
425  virtual DtTaskExecutionRules& taskExecutionRules();
426  virtual const DtTaskExecutionRules& taskExecutionRules() const;
428 
430 
431  virtual void setTaskExecutionRulesFilename(const DtFilename&);
432  virtual const DtReaderWriterFile& taskExecutionRulesFilename() const;
434 
436  virtual const DtAutoConnectionsListPtr& autoConnections() const;
437  virtual DtAutoConnectionsListPtr& autoConnections();
438 
443  virtual const std::list<DtSimArtPartDescriptor*>* completeArtPartList() const;
444 
446  virtual void connectSystems();
447 
449  bool operator==(const DtVrfObjectParameters&) const;
450  bool operator!=(const DtVrfObjectParameters&) const;
451 
452  virtual DtEnvironmentSP xmlEnvironment();
453 
456  virtual DtReaderWriterRegistryData* findProperty(const DtString& rwName) const;
457 
459  virtual const DtRwProperties& parameterData() const;
460  virtual DtRwProperties& parameterData();
461 
463  virtual const DtRwProperties& stateData() const;
464  virtual DtRwProperties& stateData();
465 
469  virtual void setPublishParameterData(bool);
470  virtual bool publishParameterData() const;
471 
472  virtual void setUiFilename(const DtString& uiFilename);
473  virtual DtString uiFilename() const;
474 
475 protected:
476 
483  virtual DtVrfSubObjectParameterList* createSubordinateObjectsList(
484  const DtSymbolString& name, DtReaderWriterRegistry* parentRegistry) const;
485 
492  virtual DtVrfSubObjectParameterList* createAttachedObjectsList(
493  const DtSymbolString& name, DtReaderWriterRegistry* parentRegistry) const;
494 
497  virtual void rebuildArtPartList();
498 
502  virtual void addArtPartsFromSystem(DtComponentSystemDescriptor* systemDesc,
503  std::list<DtSimArtPartDescriptor*>& artPartList);
504 
505  virtual void createAutomaticConnections(DtRwAutoConnection* autoConnection);
506 
507 protected:
508 
523  DtObjectType myMatchType;
524  DtObjectType myObjectType;
525 
529 
541  DtRwBoundingGeometryType myBoundingGeometryType;
542 
554  DtRwBoundingVolume myBvol;
555 
560  DtVrfObjectSubComponentTypes * myLocalSubComponentTypes;
561 
566  DtVrfObjectSubComponentTypes * myRemoteSubComponentTypes;
567 
578  DtRwFormationType myFormationType;
579 
582  DtRwAppearance myDefaultAppearance;
583 
594  DtRwForceType myForceType;
595 
602  DtRwString myCategory;
603 
610  DtRwString myEchelonLevel;
611 
617  DtRwBoolean myOrganized;
618 
624  DtRwReal myMinTickPeriod;
625 
632  DtRwReal myMinTickPeriodVariance;
633 
646  DtRwDeadReckonTypes myDeadReckoningAlgorithm;
647 
656  DtRwDeadReckonThresholds myDeadReckoningThresholds;
657 
658  DtRwBoolean myDeadReckoningAllowGuiOverrides;
659 
662  DtRadioDescriptorList myRadioDescriptorList;
663 
668  DtComponentSystemDescriptorList mySystemDescriptorList;
669 
672  DtComponentDescriptorList mySensorDescriptorList;
673 
676  DtComponentDescriptorList myControllerDescriptorList;
677 
680  DtComponentDescriptorList myActuatorDescriptorList;
681 
710  DtConnectionDescriptorList myConnectionDescriptorList;
711 
716  DtRwReal myMass;
717 
721  DtRwSensorSignatureList mySensorSignatureList;
722 
752  DtVrfSubObjectParameterList* mySubordinateObjects;
753 
757  DtVrfSubObjectParameterList* myAttachedObjects;
758 
767  DtRwString myEngagementRules;
768 
784  DtSimResourceManager myResourceManager;
785 
792  DtRwString myStateRepositoryUserExtensionType;
793 
799  DtRwBoolean myTaskedBySuperiorUponTaskComplete;
800 
807  DtVrfStateRepositoryUserExtension* myStateRepositoryUserExtension;
808 
813  DtRwTime myUnderFireTime;
814 
819  DtRwReal myUnderFireDistance;
820 
828  DtSimSector myInitialSectorOfResponsibility;
829 
836  DtReaderWriterFile myTaskExecutionRulesFilename;
838 
841  DtTaskExecutionRules myTaskExecutionRules;
842 
845  DtString myParameterType;
846 
847  static DtVrfObjectParameterFactory * theFactory;
848 
853  std::list<DtSimArtPartDescriptor*> myCompleteArtPartList;
854 
855  DtEnvValueSP* myObjectNode;
856  DtEnvironmentSP myEnvironment;
857 
858  DtAutoConnectionsListPtr myAutoConnections;
859 
862  DtRwProperties myParameterData;
863 
866  DtRwProperties myStateData;
867 
870  DtRwReal myRangeRingPublisherTickTime;
871 
877  DtRwBoolean myPublishParameterData;
878 
884  DtRwBoolean myIlluminationRecalcTime;
885 
890  DtRwString myDisplayName;
891 
896  DtRwString myDisplayDescription;
897 
903  DtRwString myUiFilename;
904 };
905 
906 inline void DtVrfObjectParameters::setParameterType(const DtString& t)
907 {
908  myParameterType = t;
909 }
910 
911 inline const DtString& DtVrfObjectParameters::parameterType() const
912 {
913  return myParameterType;
914 }
Document ID: Generated on Wed Jul 29 00:55:00 EDT 2015 from SVN revision 155257
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)