spawnControllerPSR.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2011 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once

#include <vrfobjcore/vrfProcessStateRepository.h>
#include <vrfutil/rwString.h>
#include <vrfutil/rwReal.h>
#include <bhaveSim/bhaveSimDefines.h>
#include <vrfmsgs/rwSpawnData.h>
#include "bhaveSim/rwTrafficSinkListEntry.h"
#include <vrfutil/rwTemplatedList.h>
#include <vrfutil/rwObjectTypeList.h>

namespace BHAVE
{

const char DtSpawnControllerPSRType[] = "spawn-controller-psr";

class DT_DLL_bhaveSim DtSpawnControllerPSR : public DtVrfProcessStateRepository
{
public:
   typedef DtRwTemplatedListPtr<DtRwTrafficSinkListEntry, true> DtTrafficSinkList;

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

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

   virtual ~DtSpawnControllerPSR();

   DtSpawnControllerPSR& operator=(const DtSpawnControllerPSR& orig);

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

   virtual DtString type() const;


   virtual void setNextCreationTime(double t);
   virtual double nextCreationTime() const;

   virtual void setLastCycleStartTime(const DtTime start);
   virtual DtTime lastCycleStartTime() const;

   virtual void setNextCycleStartTime(const DtTime start);
   virtual DtTime nextCycleStartTime() const;


   virtual DtTrafficSinkList& trafficAndSinkList();
   virtual const DtTrafficSinkList& trafficAndSinkList() const;
   virtual void addTraffic(const DtString& trafficName, const DtString& sinkName);

   virtual void setTemplateName(const DtString & name);
   virtual const DtString& templateName() const;


   virtual void setSpawnParameters (const DtRwSpawnData & params);
   virtual const DtRwSpawnData & spawnParameters () ;

   virtual void setIsTimeBased (const bool tB);
   virtual bool isTimeBased() const;

   virtual void setUsesClockTime( const bool cT);
   virtual bool usesClockTime()const;



   virtual void setSpawnStartTime(double t);
   virtual double spawnStartTime() const;


   virtual void setSpawnEndTime(double t);
   virtual double spawnEndTime() const;


   virtual void setspawnPeriod(double t);
   virtual double spawnPeriod() const;


   virtual void setSpawnVariance(double t);
   virtual double spawnVariance() const;


   virtual void setIsCyclical(const bool c);
   virtual bool isCyclical() const;

   virtual void setCyclePeriod(const DtReal cP);
   virtual DtReal cyclePeriod() const;

   virtual void setBurstPeriodVariance(const DtReal bpv);
   virtual DtReal burstPeriodVariance() const;

   virtual void setDutyCycle(const DtReal dC);
   virtual DtReal dutyCycle() const;

   virtual void setStartOffset(const DtReal sO);
   virtual DtReal startOffset() const;


   virtual void setSpecifySpeed(bool);
   virtual bool specifySpeed() const;


   virtual void setSpawnMaxCount(unsigned n);
   virtual unsigned spawnMaxCount() const;


   virtual void setSpawnMinSpeed(double t);
   virtual double spawnMinSpeed() const;


   virtual void setSpawnMaxSpeed(double t);
   virtual double spawnMaxSpeed() const;



   virtual const DtRwObjectTypeInfoList& spawnObjectTypes() const;
   virtual void setSpawnObjectTypes(const DtRwObjectTypeInfoList &typeList);


   virtual void setCreateOnVectorNetwork(bool t);
   virtual bool createOnVectorNetwork() const;

   virtual const DtRwStringList& sinkNodeNames() const;
   virtual void setSinkNodeNames(const DtRwStringList& sinkNodes);
   virtual void removeSinkNode(const DtString& delName);
   virtual void renameSinkNode(const DtString& oldName,
      const DtString& newName);

   virtual const DtPlan& entityPlan() const;
   virtual void setEntityPlan(DtPlan& plan);


public:

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

protected:
   DtRwReal myNextCreationTime;
   DtRwReal myLastCycleStartTime;
   DtRwReal myNextCycleStartTime;
   DtTrafficSinkList myTrafficSinkList;

   DtRwSpawnData mySpawnParameters;

   const DtRwSpawnData *myTemplate;
};

} //namespace BHAVE