VR-Forces 4.7 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
rwScriptReactiveTaskEntry.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2013 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 #pragma once
6 
7 #include "vrfobjcoreDefines.h"
8 
9 #include <readerWriter/rwBoolean.h>
10 #include <readerWriter/rwInt.h>
11 #include <readerWriter/rwString.h>
12 #include <set>
13 #include "vrfobjcore/scriptInterface.h"
14 #include <boost/shared_ptr.hpp>
15 #include <readerWriter/rwReal.h>
16 #include <readerWriter/readerWriter.h>
17 #include <readerWriter/symbolString.h>
18 #include <readerWriter/rwVariableBindings.h>
19 #include "vrftasks/vrfObjectMessageTypeTemplate.h"
20 
21 class DT_DLL_vrfobjcore DtRwScriptReactiveTaskEntry : public DtReaderWriter
22 {
23 public:
24  DtRwScriptReactiveTaskEntry();
25  DtRwScriptReactiveTaskEntry(const DtString& name, DtReaderWriterRegistry* parentRegistry = NULL);
26 
27  DtRwScriptReactiveTaskEntry(const DtString& name, const DtRwScriptReactiveTaskEntry& orig, DtReaderWriterRegistry* parentRegistry = NULL);
28  DtRwScriptReactiveTaskEntry& operator=(const DtRwScriptReactiveTaskEntry& orig);
29 
30  virtual ~DtRwScriptReactiveTaskEntry();
31 
32  virtual const char* readerWriterType() const;
33 
37  virtual bool isDefaultEnabled() const { return myIsDefaultEnabled; }
38  virtual void setIsDefaultEnabled(bool enabled) { myIsDefaultEnabled = enabled; }
39 
40  virtual bool isEnabled() const { return myIsEnabled; }
41  virtual void setIsEnabled(bool enabled) { myIsEnabled = enabled; }
42 
43  virtual bool isActive() const { return myIsActive; }
44  virtual void setIsActive(bool active) { myIsActive = active; }
45 
46  virtual bool isSuspended() const { return myIsSuspended; }
47  virtual void setIsSuspended(bool suspended) { myIsSuspended = suspended; }
48 
49  virtual bool isDefaultPriority() const { return myIsDefaultPriority; }
50  virtual void setIsDefaultPriority(bool isDefault) { myIsDefaultPriority = isDefault; }
51 
52  virtual bool shouldInvokeCheckInit() const { return myShouldInvokeCheckInit; }
53  virtual void setShouldInvokeCheckInit(bool shouldInvoke) { myShouldInvokeCheckInit = shouldInvoke; }
54 
55  virtual int priority() const { return myPriority; }
56  virtual void setPriority(int level) { myPriority = level; }
57 
58  virtual int taskId() const { return myTaskId; }
59  virtual void setTaskId(int tid) { myTaskId = tid; }
60 
61  virtual int suspendId() const { return mySuspendId; }
62  virtual void setSuspendId(int spid) { mySuspendId = spid; }
63 
64  virtual const DtSimTaskMessageType& scriptId() const;
65  virtual void setScriptId(const DtSimTaskMessageType& sid);
66  virtual void setScriptId(const std::string& sid);
67  virtual void setScriptId(const DtString& sid);
68 
69  virtual const DtString& systemName() const { return mySystemName; }
70  virtual void setSystemName(const DtString& sid) { mySystemName = sid; }
71 
73  virtual std::set<DtString> actionCategories() const;
74  virtual void setActionCategories(const std::set<std::string>& categories);
75 
76  virtual const DtString& scriptInterfaceState() { return myScriptInterfaceState; }
77  virtual void setScriptInterfaceState(const DtString& state) { myScriptInterfaceState = state; }
78 
79  virtual const DtRwVariableBindings& parameters() const { return myParameters; }
80  virtual void setParameters(const DtRwVariableBindings& params) { myParameters = params; }
81 
82  virtual double tickPeriod() const { return myTickPeriod; }
83  virtual void setTickPeriod(double period) { myTickPeriod = period; }
84 
85  virtual double nextTickTime() const { return myNextTickTime; }
86  virtual void setNextTickTime(double period) { myNextTickTime = period; }
87 
88  virtual bool tickWhilePaused() const { return myTickWhilePaused; }
89  virtual void setTickWhilePaused(bool enable) { myTickWhilePaused = enable; }
90 
91  virtual bool checkpointModeUseCheckpointState() const { return myCheckpointModeUseCheckpointState; }
92  virtual void setCheckpointModeUseCheckpointState(bool enable) { myCheckpointModeUseCheckpointState = enable; }
93 
94  virtual double nextTickTimeWhilePaused() const { return myNextTickTimeWhilePaused; }
95  virtual void setNextTickTimeWhilePaused(double t) { myNextTickTimeWhilePaused = t; }
96 
97  virtual boost::shared_ptr<DtScriptInterface> scriptInterface() { return myScriptInterface; }
98  virtual void setScriptInterface(boost::shared_ptr<DtScriptInterface> ptr) { myScriptInterface = ptr; }
99 
100  virtual bool isMarkedForDeletion() const { return myIsMarkedForDeletion; }
101  virtual void markForDeletion() { myIsMarkedForDeletion = true; }
102 
103  virtual bool isTimeToExecuteScript(double currentSimTime, double currentRealTime, bool isPaused);
104 
105 protected:
106  DtRwBoolean myIsDefaultEnabled;
107  DtRwBoolean myIsEnabled;
108  DtRwBoolean myIsActive;
109  DtRwBoolean myIsSuspended;
110  DtRwBoolean myIsDefaultPriority;
111  DtRwBoolean myShouldInvokeCheckInit;
112  DtRwInt myPriority;
113  DtRwInt myTaskId;
114  DtRwInt mySuspendId;
115  DtRwString myScriptId;
116  mutable DtSimTaskMessageType myTaskMessageScriptId;
117  DtRwString mySystemName;
118  DtRwStringList myActionCategories;
119  DtRwString myScriptInterfaceState;
120  DtRwVariableBindings myParameters;
121  DtRwReal myTickPeriod;
122  DtRwReal myNextTickTime;
123  DtRwBoolean myTickWhilePaused;
124  DtReal myNextTickTimeWhilePaused;
125  DtRwBoolean myCheckpointModeUseCheckpointState;
126 
127  boost::shared_ptr<DtScriptInterface> myScriptInterface;
128  bool myIsMarkedForDeletion;
129 };
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)