rwScriptInformation.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2012 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/



#pragma once

#include "vrfutil/readerWriter.h"
#include "vrfutil/rwInt.h"
#include "vrfutil/rwReal.h"
#include "vrfutil/rwBoolean.h"
#include "vrfutil/rwString.h"

#include "vrfutil/vrfutilDefines.h"
class DT_DLL_vrfutil DtRwScriptInformation : public DtReaderWriter
{
public:

   DtRwScriptInformation();

   DtRwScriptInformation(const DtString& name, DtReaderWriterRegistry* const 
      parentRegistry = NULL);
   DtRwScriptInformation(const DtSymbolString& name, DtReaderWriterRegistry* const 
      parentRegistry = NULL);

   virtual ~DtRwScriptInformation();

   DtRwScriptInformation(const DtString& name, const DtRwScriptInformation& orig, 
      DtReaderWriterRegistry* parentRegistry = NULL);
   DtRwScriptInformation(const DtSymbolString& name, const DtRwScriptInformation& orig, 
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtRwScriptInformation& operator=(const DtRwScriptInformation& orig);

   DtRwScriptInformation* clone() const;

   bool operator==(const DtRwScriptInformation&) const;
   bool operator!=(const DtRwScriptInformation&) const;


   void setScriptId(const DtString&);
   const DtString& scriptId() const;

   void setTickPeriod(double);
   double tickPeriod() const;

   void setNextTickTime(double);
   double nextTickTime() const;

   void setTickWhilePaused(bool);
   bool tickWhilePaused() const;

   void setNextTickTimeWhilePaused(double);
   double nextTickTimeWhilePaused() const;

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

   void setBackgroundProcessId(int);
   int backgroundProcessId() const;

protected:
   DtRwString  myScriptId;
   DtRwReal    myTickPeriod;
   DtRwReal    myNextTickTime;
   DtRwInt     myBackgroundProcessId;
   DtRwBoolean myTickWhilePaused;
   DtRwBoolean myCheckpointModeUseCheckpointState;
   DtReal      myNextTickTimeWhilePaused;
};