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