rwScriptReactiveTaskEntry.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2013 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
#pragma once

#include "vrfobjcoreDefines.h"

#include <readerWriter/rwBoolean.h>
#include <readerWriter/rwInt.h>
#include <readerWriter/rwString.h>
#include <set>
#include "vrfobjcore/scriptInterface.h"
#include <boost/shared_ptr.hpp>
#include <readerWriter/rwReal.h>
#include <readerWriter/readerWriter.h>
#include <readerWriter/symbolString.h>
#include <readerWriter/rwVariableBindings.h>
#include "vrftasks/vrfObjectMessageTypeTemplate.h"

class DT_DLL_vrfobjcore DtRwScriptReactiveTaskEntry : public DtReaderWriter
{
public:
   DtRwScriptReactiveTaskEntry();
   DtRwScriptReactiveTaskEntry(const DtString& name, DtReaderWriterRegistry* parentRegistry = NULL);

   DtRwScriptReactiveTaskEntry(const DtString& name, const DtRwScriptReactiveTaskEntry& orig, DtReaderWriterRegistry* parentRegistry = NULL);
   DtRwScriptReactiveTaskEntry& operator=(const DtRwScriptReactiveTaskEntry& orig);

   virtual ~DtRwScriptReactiveTaskEntry();

   virtual const char* readerWriterType() const;

   virtual bool isDefaultEnabled() const { return myIsDefaultEnabled; }
   virtual void setIsDefaultEnabled(bool enabled) { myIsDefaultEnabled = enabled; }

   virtual bool isEnabled() const { return myIsEnabled; }
   virtual void setIsEnabled(bool enabled) { myIsEnabled = enabled; }

   virtual bool isActive() const { return myIsActive; }
   virtual void setIsActive(bool active) { myIsActive = active; }

   virtual bool isSuspended() const { return myIsSuspended; }
   virtual void setIsSuspended(bool suspended) { myIsSuspended = suspended; }

   virtual bool isDefaultPriority() const { return myIsDefaultPriority; }
   virtual void setIsDefaultPriority(bool isDefault) { myIsDefaultPriority = isDefault; }

   virtual bool shouldInvokeCheckInit() const { return myShouldInvokeCheckInit; }
   virtual void setShouldInvokeCheckInit(bool shouldInvoke) { myShouldInvokeCheckInit = shouldInvoke; }

   virtual int priority() const { return myPriority; }
   virtual void setPriority(int level) { myPriority = level; }

   virtual int taskId() const { return myTaskId; }
   virtual void setTaskId(int tid) { myTaskId = tid; }

   virtual int suspendId() const { return mySuspendId; }
   virtual void setSuspendId(int spid) { mySuspendId = spid; }

   virtual const DtSimTaskMessageType& scriptId() const;
   virtual void setScriptId(const DtSimTaskMessageType& sid);
   virtual void setScriptId(const std::string& sid);
   virtual void setScriptId(const DtString& sid);

   virtual const DtString& systemName() const  { return mySystemName; }
   virtual void setSystemName(const DtString& sid) { mySystemName = sid; }

   virtual std::set<DtString> actionCategories() const;
   virtual void setActionCategories(const std::set<std::string>& categories);

   virtual const DtString& scriptInterfaceState() { return myScriptInterfaceState; }
   virtual void setScriptInterfaceState(const DtString& state) { myScriptInterfaceState = state; }

   virtual const DtRwVariableBindings& parameters() const { return myParameters; }
   virtual void setParameters(const DtRwVariableBindings& params) { myParameters = params; }
 
   virtual double tickPeriod() const { return myTickPeriod; }
   virtual void setTickPeriod(double period) { myTickPeriod = period; }

   virtual double nextTickTime() const { return myNextTickTime; }
   virtual void setNextTickTime(double period) { myNextTickTime = period; }

   virtual bool tickWhilePaused() const { return myTickWhilePaused; }
   virtual void setTickWhilePaused(bool enable) { myTickWhilePaused = enable; }

   virtual bool checkpointModeUseCheckpointState() const { return myCheckpointModeUseCheckpointState; }
   virtual void setCheckpointModeUseCheckpointState(bool enable) { myCheckpointModeUseCheckpointState = enable; }

   virtual double nextTickTimeWhilePaused() const { return myNextTickTimeWhilePaused; }
   virtual void setNextTickTimeWhilePaused(double t) { myNextTickTimeWhilePaused = t; }

   virtual boost::shared_ptr<DtScriptInterface> scriptInterface() { return myScriptInterface; }
   virtual void setScriptInterface(boost::shared_ptr<DtScriptInterface> ptr) { myScriptInterface = ptr; }

   virtual bool isMarkedForDeletion() const { return myIsMarkedForDeletion; }
   virtual void markForDeletion() { myIsMarkedForDeletion = true; }

   virtual bool isTimeToExecuteScript(double currentSimTime, double currentRealTime, bool isPaused);

protected:
   DtRwBoolean myIsDefaultEnabled;
   DtRwBoolean myIsEnabled;
   DtRwBoolean myIsActive;
   DtRwBoolean myIsSuspended;
   DtRwBoolean myIsDefaultPriority;
   DtRwBoolean myShouldInvokeCheckInit;
   DtRwInt myPriority;
   DtRwInt myTaskId;
   DtRwInt mySuspendId;
   DtRwString myScriptId;
   mutable DtSimTaskMessageType myTaskMessageScriptId;
   DtRwString mySystemName;
   DtRwStringList myActionCategories;
   DtRwString myScriptInterfaceState;
   DtRwVariableBindings myParameters;
   DtRwReal myTickPeriod;
   DtRwReal myNextTickTime;
   DtRwBoolean myTickWhilePaused;
   DtReal myNextTickTimeWhilePaused;
   DtRwBoolean myCheckpointModeUseCheckpointState;

   boost::shared_ptr<DtScriptInterface> myScriptInterface;
   bool myIsMarkedForDeletion;
};