VR-Forces 4.7 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
rwScenarioEvent.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2013 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
9 #pragma once
10 
11 #include "vrfutil/vrfutilDefines.h"
12 #include <readerWriter/readerWriter.h>
13 #include <readerWriter/rwReal.h>
14 #include <readerWriter/rwString.h>
15 #include <readerWriter/rwBoolean.h>
16 #include "readerWriter/rwVector.h"
17 #include <readerWriter/rwInt.h>
18 #include "vrfutil/nLengthIntegerVector.h"
19 #include "vrfutil/rwNLengthUUIDVector.h"
20 #include "vrfutil/rwUUID.h"
21 
22 const int DtSEPredecessorType_Active = 1;
23 const int DtSEPredecessorType_Concluded = 2;
24 
25 const int DtSETriggerStatus_None = 0;
26 const int DtSETriggerStatus_Pending = 1;
27 const int DtSETriggerStatus_Suspended = 2;
28 const int DtSETriggerStatus_InProcess = 3;
29 const int DtSETriggerStatus_Concluded = 4;
30 
31 const int DtSEStartTimeType_Start = 0;
32 const int DtSEStartTimeType_Manual = 1;
33 const int DtSEStartTimeType_Link = 2;
34 const int DtSEStartTimeType_SPLUS = 3;
35 const int DtSEStartTimeType_Immediate = 4;
36 const int DtSEStartTimeType_IntelligenceObject = 100;
37 
38 const int DtSEEndTimeType_Manual = 0;
39 const int DtSEEndTimeType_TOD = 1;
40 const int DtSEEndTimeType_SPLUS = 2;
41 const int DtSEEndTimeType_Never = 3;
42 const double DtScenarioEventVersion = 2.0;
43 
46 class DT_DLL_vrfutil DtRwScenarioEventUUID : public DtRwUUID
47 {
48 public:
49  DtRwScenarioEventUUID();
50  DtRwScenarioEventUUID(const DtString& name, DtReaderWriterRegistry* const parentRegistry);
51  DtRwScenarioEventUUID(const DtSymbolString& name, DtReaderWriterRegistry* const parentRegistry);
52 
53  DtRwScenarioEventUUID(const DtRwScenarioEventUUID& orig, DtReaderWriterRegistry* const parentRegistry);
54 
55  DtRwScenarioEventUUID& operator=(const DtUUID&);
56  DtRwScenarioEventUUID& operator=(const DtRwScenarioEventUUID&);
57 
58 protected:
59  virtual DtlObjPtr getData(DtlObjPtr args, const SearchPaths& searchPaths,
60  const DtVariableBindingsList& variableBindings);
61  virtual void getData(const DtEnvironmentSP, const DtEnvValueSP,
62  const SearchPaths& searchPaths = SearchPaths(),
63  const DtVariableBindingsList& bindings = DtVariableBindingsList());
64 };
65 
68 class DT_DLL_vrfutil DtRwScenarioEvent : public DtReaderWriter
69 {
70 public:
72 
73  DtRwScenarioEvent(const DtString& name,
74  DtReaderWriterRegistry* parentRegistry = 0);
75 
77  DtRwScenarioEvent(const DtRwScenarioEvent & orig,
78  DtReaderWriterRegistry * parentRegistry = 0);
79 
81  DtRwScenarioEvent & operator=(const DtRwScenarioEvent & orig);
82 
84  virtual ~DtRwScenarioEvent();
85 
86  virtual const char* readerWriterType() const;
87  static const char* theXmlType();
88 
89  virtual const char* xmlType() const
90  {
91  return theXmlType();
92  }
93 
94 public:
95  virtual const DtString& caption() const;
96  virtual void setCaption( const DtString& input );
97 
98  virtual int endTimeType() const;
99  virtual void setEndTimeType( int input );
100 
101  virtual double endTimeValue() const;
102  virtual void setEndTimeValue( double tValue );
103 
104  virtual double simTimeEnded() const;
105  virtual void setSimTimeEnded( double tValue );
106 
107  virtual const DtNLengthIntegerVector& forces() const;
108  virtual void addForce( int input );
109  virtual void removeForce (int);
110  virtual void setForces(const DtNLengthIntegerVector&);
111  virtual bool isAvailableToForce(int) const;
112  virtual bool isAvailableToForce(const std::vector<int>&) const;
113  virtual void clearForces();
114 
115  virtual const unsigned int forcePermissionMask() const;
116  virtual void setForcePermissionMask( int input );
117 
118  virtual const DtVector& location() const;
119  virtual void setLocation( const DtVector& input );
120 
121  virtual bool isLocationSet() const;
122  virtual void setLocationIsSet(bool isSet);
123 
124  virtual const DtString& symbolFile() const;
125  virtual void setSymbolFile( const DtString& input);
126 
127  virtual const DtString& mediaText() const;
128  virtual void setMediaText( const DtString& input);
129 
130  virtual const DtString& mediaSound() const;
131  virtual void setMediaSound( const DtString& input);
132 
133  virtual const DtString& mediaVideo() const;
134  virtual void setMediaVideo( const DtString& input);
135 
136  virtual const DtString& mediaPicture() const;
137  virtual void setMediaPicture( const DtString& input);
138 
139  virtual const DtString& multipleChoiceQuiz() const;
140  virtual void setMultipleChoiceQuiz( const DtString& input );
141 
142  virtual int ordinal() const;
143  virtual void setOrdinal(int nOrd);
144 
145  virtual void setEnabled(bool);
146  virtual bool enabled() const;
147 
148  virtual void setEnabledStateLinkedTo(const DtUUID&);
149  virtual const DtUUID& enabledStateLinkedTo() const;
150 
151  virtual void addToPredecessorList( const DtUUID& pUniqueID,
152  int predType = DtSEPredecessorType_Concluded);
153 
154  struct PredecessorItem
155  {
156  DtRwScenarioEventUUID uniqueId;
157  int predecessorType;
158  };
159 
160  typedef std::vector<PredecessorItem> PredecessorList;
161 
162  virtual PredecessorList predecessorList() const;
163  virtual void setPredecessorList(const PredecessorList&);
164 
165  virtual void clearPredecessorList();
166 
167  virtual void removeFromPredecessorList( const DtUUID& pUniqueID );
168 
169  virtual bool resolved() const;
170  virtual void setResolved( bool input );
171 
172  virtual int startTimeType() const;
173  virtual void setStartTimeType( int input );
174  virtual DtString startTimeString() const;
175 
176  virtual double startTimeValue() const;
177  virtual void setStartTimeValue( double tValue );
178 
179  virtual bool isQuickLaunch() const;
180  virtual void setIsQuickLaunch( bool );
181 
182  virtual void setScaledPicture(bool);
183  virtual bool scaledPicture() const;
184 
185  virtual double simTimeStarted() const;
186  virtual void setSimTimeStarted( double tValue );
187 
188  virtual int triggerStatus() const;
189  virtual void setTriggerStatus( int input );
190 
191  virtual const DtUUID& uniqueId() const;
192  virtual void setUniqueId( const DtUUID& input );
193 
194  virtual double version() const;
195  virtual void setVersion( double input );
196 
197  virtual double predecessorDeltaValue() const;
198  virtual void setPredecessorDeltaValue( double delta );
199 
203  virtual void addSensorSignature(const DtString&, double val);
204  virtual void removeSensorSignature(const DtString&);
205  virtual void setSensorSignatures(const std::map<std::string, double>&);
206  virtual std::map<std::string, double> sensorSignatures() const;
208 
209 private:
211  DtRwScenarioEvent();
212 
213 protected:
214 
215  DtRwString myCaption;
216  DtRwInt myEndTimeType;
217  DtRwReal myEndTime;
218  DtRwInt myStartTimeType;
219  DtRwReal myStartTime;
220  DtNLengthIntegerVector myForces;
221  DtRwInt myForcePermissionMask;
222  DtRwVector myLocation;
223  DtRwBoolean myUseLocation;
224  DtRwString mySymbolFile;
225  DtRwString myMediaText;
226  DtRwString myMediaVideo;
227  DtRwString myMediaSound;
228  DtRwString myMediaPicture;
229  DtRwString myMultipleChoiceQuiz;
230  DtRwInt myOrdinal;
231  DtRwString myPredecessorList;
232  DtRwBoolean myResolved;
233  DtRwInt myTriggerStatus;
234  DtRwScenarioEventUUID myUniqueId;
235  DtRwInt myVersion;
236  DtRwReal myPredecessorDeltaValue;
237  DtRwReal mySimTimeStarted;
238  DtRwReal mySimTimeEnded;
239  DtRwBoolean myIsQuickLaunch;
240  DtRwBoolean myScaledPicture;
241  DtRwUUID myEnabledStateLinkedTo;
242  DtRwBoolean myEnabled;
243 
244  DtRwString mySensorSignatures;
245 };
Document ID: Generated on Fri Apr 26 21:53:14 EDT 2019 from SVN revision 197883
Copyright © 2005-2019 VT MAK. All Rights Reserved (www.mak.com)