VR-Forces 4.3 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 
20 const int DtSEPredecessorType_Active = 1;
21 const int DtSEPredecessorType_Concluded = 2;
22 
23 const int DtSETriggerStatus_None = 0;
24 const int DtSETriggerStatus_Pending = 1;
25 const int DtSETriggerStatus_Suspended = 2;
26 const int DtSETriggerStatus_InProcess = 3;
27 const int DtSETriggerStatus_Concluded = 4;
28 
29 const int DtSEStartTimeType_Start = 0;
30 const int DtSEStartTimeType_Manual = 1;
31 const int DtSEStartTimeType_Link = 2;
32 const int DtSEStartTimeType_SPLUS = 3;
33 const int DtSEStartTimeType_Immediate = 4;
34 const int DtSEStartTimeType_IntelligenceObject = 100;
35 
36 const int DtSEEndTimeType_Manual = 0;
37 const int DtSEEndTimeType_TOD = 1;
38 const int DtSEEndTimeType_SPLUS = 2;
39 
42 class DT_DLL_vrfutil DtRwScenarioEvent : public DtReaderWriter
43 {
44 public:
46 
47  DtRwScenarioEvent(const DtString& name,
48  DtReaderWriterRegistry* parentRegistry = 0);
49 
51  DtRwScenarioEvent(const DtRwScenarioEvent & orig,
52  DtReaderWriterRegistry * parentRegistry = 0);
53 
55  DtRwScenarioEvent & operator=(const DtRwScenarioEvent & orig);
56 
58  virtual ~DtRwScenarioEvent();
59 
60  virtual const char* readerWriterType() const;
61  static const char* theXmlType();
62 
63  virtual const char* xmlType() const
64  {
65  return theXmlType();
66  }
67 
68 public:
69  virtual const DtString& caption() const;
70  virtual void setCaption( const DtString& input );
71 
72  virtual int endTimeType() const;
73  virtual void setEndTimeType( int input );
74 
75  virtual double endTimeValue() const;
76  virtual void setEndTimeValue( double tValue );
77 
78  virtual double simTimeEnded() const;
79  virtual void setSimTimeEnded( double tValue );
80 
81  virtual const DtNLengthIntegerVector& forces() const;
82  virtual void addForce( int input );
83  virtual void removeForce (int);
84  virtual void setForces(const DtNLengthIntegerVector&);
85  virtual bool isAvailableToForce(int) const;
86  virtual bool isAvailableToForce(const std::vector<int>&) const;
87  virtual void clearForces();
88 
89  virtual const unsigned int forcePermissionMask() const;
90  virtual void setForcePermissionMask( int input );
91 
92  virtual const DtVector& location() const;
93  virtual void setLocation( const DtVector& input );
94 
95  virtual bool isLocationSet() const;
96  virtual void setLocationIsSet(bool isSet);
97 
98  virtual const DtString& symbolFile() const;
99  virtual void setSymbolFile( const DtString& input);
100 
101  virtual const DtString& mediaText() const;
102  virtual void setMediaText( const DtString& input);
103 
104  virtual const DtString& mediaSound() const;
105  virtual void setMediaSound( const DtString& input);
106 
107  virtual const DtString& mediaVideo() const;
108  virtual void setMediaVideo( const DtString& input);
109 
110  virtual const DtString& mediaPicture() const;
111  virtual void setMediaPicture( const DtString& input);
112 
113  virtual const DtString& multipleChoiceQuiz() const;
114  virtual void setMultipleChoiceQuiz( const DtString& input );
115 
116  virtual int ordinal() const;
117  virtual void setOrdinal(int nOrd);
118 
119  virtual void addToPredecessorList( const DtString& pUniqueID,
120  int predType = DtSEPredecessorType_Concluded);
121 
122  struct PredecessorItem
123  {
124  DtString uniqueId;
125  int predecessorType;
126  };
127 
128  typedef std::vector<PredecessorItem> PredecessorList;
129 
130  virtual PredecessorList predecessorList() const;
131  virtual void setPredecessorList(const PredecessorList&);
132 
133  virtual void clearPredecessorList();
134 
135  virtual void removeFromPredecessorList( const DtString& pUniqueID );
136 
137  virtual bool resolved() const;
138  virtual void setResolved( bool input );
139 
140  virtual int startTimeType() const;
141  virtual void setStartTimeType( int input );
142  virtual DtString startTimeString() const;
143 
144  virtual double startTimeValue() const;
145  virtual void setStartTimeValue( double tValue );
146 
147  virtual double simTimeStarted() const;
148  virtual void setSimTimeStarted( double tValue );
149 
150  virtual int triggerStatus() const;
151  virtual void setTriggerStatus( int input );
152 
153  virtual const DtString& uniqueId() const;
154  virtual void setUniqueId( const DtString& input );
155 
156  virtual double version() const;
157  virtual void setVersion( double input );
158 
159  virtual double predecessorDeltaValue() const;
160  virtual void setPredecessorDeltaValue( double delta );
161 
165  virtual void addSensorSignature(const DtString&, double val);
166  virtual void removeSensorSignature(const DtString&);
167  virtual void setSensorSignatures(const std::map<std::string, double>&);
168  virtual std::map<std::string, double> sensorSignatures() const;
170 
171 private:
173  DtRwScenarioEvent();
174 
175 protected:
176 
177  DtRwString myCaption;
178  DtRwInt myEndTimeType;
179  DtRwReal myEndTime;
180  DtRwInt myStartTimeType;
181  DtRwReal myStartTime;
182  DtNLengthIntegerVector myForces;
183  DtRwInt myForcePermissionMask;
184  DtRwVector myLocation;
185  DtRwBoolean myUseLocation;
186  DtRwString mySymbolFile;
187  DtRwString myMediaText;
188  DtRwString myMediaVideo;
189  DtRwString myMediaSound;
190  DtRwString myMediaPicture;
191  DtRwString myMultipleChoiceQuiz;
192  DtRwInt myOrdinal;
193  DtRwString myPredecessorList;
194  DtRwBoolean myResolved;
195  DtRwInt myTriggerStatus;
196  DtRwString myUniqueId;
197  DtRwInt myVersion;
198  DtRwReal myPredecessorDeltaValue;
199  DtRwReal mySimTimeStarted;
200  DtRwReal mySimTimeEnded;
201 
202  DtRwString mySensorSignatures;
203 };
Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)