launchExpendableResourcePSR.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2011 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: launchExpendableResourcePSR.h,v $ $Revision: 1.1 $ $State: Exp $
** Created: 4/28/11 MEM
*******************************************************************************/

#pragma once

#include "vrfobjcore/vrfProcessStateRepository.h"
#include <readerWriter/rwInt.h>
#include <readerWriter/rwReal.h>
#include <readerWriter/rwBoolean.h>
#include <readerWriter/rwString.h>

#include <set>


#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtLaunchExpendableResourcePSR : public DtVrfProcessStateRepository
{
public:

   enum TaskState
   {
      NotTasked,
      Tasked,
      StopTask,
      TaskComplete,
      TaskFailed
   };

   DtLaunchExpendableResourcePSR(DtLocalObject* vrfObject, 
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);

   DtLaunchExpendableResourcePSR(const DtLaunchExpendableResourcePSR& orig,
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);

   virtual ~DtLaunchExpendableResourcePSR();

   DtLaunchExpendableResourcePSR& operator=(const DtLaunchExpendableResourcePSR& orig);

   virtual DtVrfProcessStateRepository* clone(
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0) const;

   virtual DtString type() const;

   virtual void setNumberLeftToFire(const int number);
   virtual const int numberLeftToFire() const;

   virtual void reduceNumberLeftToFire(const int reduce);

   virtual void setElapsedTimeBetweenInterval(const double time);
   virtual const double elapsedTimeBetweenInterval() const;

   virtual void setAutoLaunchEnabled(bool enabled);
   virtual bool autoLaunchEnabled() const;
   virtual bool autoLaunchEnabledOnSpecified() const;

   virtual void setAutoLaunchSubtaskId(const int id);
   virtual const int autoLaunchSubtaskId() const;

   virtual void setAutoLaunchRange(const double range);
   virtual const double autoLaunchRange() const;

   virtual void setElapsedTimeBetweenAutoLaunches(const double time);
   virtual const double elapsedTimeBetweenAutoLaunches() const;

   virtual void addLaunchableResource(const DtString& resourceName);

   virtual bool isLaunchableResource(const DtString& resourceName) const;

   virtual void setResourceToUse(const DtString& resourceName);
   virtual DtString resourceToUse() const;

   virtual void setTimeInterval(double interval);
   virtual double timeInterval() const;

   virtual void setTaskState(TaskState interval);
   virtual TaskState taskState() const;

public:

   static DtVrfProcessStateRepository* creator (const DtString& rwName,
      DtLocalObject* vrfObject, DtReaderWriterRegistry* parentRegistry);

protected:

   DtRwInt  myNumberLeftToFire;

   DtRwReal myElapsedTimeBetweenInterval;

   DtRwBoolean myAutoLaunchEnabled;

   DtRwReal    myAutoLaunchRange;

   DtRwReal    myTimeElapsedBetweenAutoLaunches;

   DtRwInt     myAutoLaunchSubtaskId;

   DtRwString  myResourceToUse;
   DtRwReal    myTimeInterval;
   DtRwInt     myTaskState;

   std::set<DtString> myLaunchableResources;
};