include/vrfmsgs/rwSpawnData.h

Go to the documentation of this file.

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

#pragma once

#include "vrfmsgs/vrfmsgsDefines.h"
#include <vrfutil/rdrWritr.h>
#include <vrfutil/rwString.h>
#include <vrfutil/rwReal.h>
#include <vrfutil/rwUnsigned.h>
#include <vrfutil/rwBoolean.h>
#include <vrfutil/rwObjType.h>
#include <vrfutil/rwObjectTypeInfo.h>
#include <vrfutil/rwStringList.h>
#include <vrfplan/plan.h>
#include <vlutil/vlString.h>


class DT_DLL_vrfmsgs DtRwSpawnData : public DtReaderWriter
{
//*******************************************************************
//*******************************************************************
protected:
   DtRwSpawnData();

public:

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

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

   DtRwSpawnData(const DtRwSpawnData & orig,
      const DtString & name = "temp-spawn-data",
      DtReaderWriterRegistry* parentRegistry = NULL);

   const DtRwSpawnData & operator=(const DtRwSpawnData & orig);

   virtual ~DtRwSpawnData();

   virtual const char* readerWriterType() const;

   virtual DtString stringRep() const;

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

   virtual const DtString& templateDescription() const;
   virtual void setTemplateDescription(const DtString& desc);

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

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


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

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

   virtual void setSpawnPeriod(DtReal t);
   virtual DtReal spawnPeriod() const;

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

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

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

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

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

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



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

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

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

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

   /*
   virtual void setSpawnObjectTypes(const DtRwObjectTypeList& t);
   virtual const DtRwObjectTypeList& spawnObjectTypes() const;
   virtual DtRwObjectTypeList& spawnObjectTypes();
   virtual void addSpawnObjectType(const DtRwObjectType& newType);
   virtual void removeSpawnObjectType(const DtRwObjectType& remType);
   virtual void removeSpawnObjectType(const DtString& name);
   */
   virtual void setSpawnObjectTypes(const DtRwObjectTypeInfoList& t);
   virtual const DtRwObjectTypeInfoList& spawnObjectTypes() const;
   virtual DtRwObjectTypeInfoList& spawnObjectTypes();

   virtual void addSpawnObjectType(const DtRwObjectTypeInfo& newType);

   virtual void removeSpawnObjectType(const DtRwObjectType& remType);

   virtual void removeSpawnObjectType(const DtString& name);

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

   virtual void setSinkNodeNames(const DtRwStringList& t);
   virtual const DtRwStringList& sinkNodeNames() const;
   virtual DtRwStringList& sinkNodeNames();
   virtual bool isInList(const DtString& testName) const;
   virtual void addSinkNode(const DtString& name);
   virtual void removeSinkNode(const DtString& name);

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


protected:

   DtRwString mySpawnTemplateName;
   DtRwString myDescription;

   DtRwBoolean myIsTimeBased;
   DtRwBoolean myUsesClockTime;
   DtRwReal mySpawnStartTime; 
   DtRwReal mySpawnEndTime;
   DtRwReal mySpawnPeriod;
   DtRwReal mySpawnVariance;

   DtRwBoolean myIsCyclical;
   DtRwReal myCyclePeriod;
   DtRwReal myCyclePeriodVariance;
   DtRwReal myDutyCycle;
   DtRwReal myStartOffset;

   DtRwUnsigned  mySpawnMaxCount;
   DtRwReal mySpawnMinSpeed;
   DtRwReal mySpawnMaxSpeed;
   DtRwObjectTypeInfoList mySpawnObjectTypes;
   DtRwBoolean myCreateOnVectorNetwork;
   DtRwStringList mySinkNodeNames;
   DtPlan myPlan; 
   DtRwBoolean mySpecifySpeed;

};

namespace DtBufferSerialize
{
   DT_DLL_vrfmsgs int getSize(const DtRwSpawnData&  contentPtr);

   DT_DLL_vrfmsgs char *encode(const DtRwSpawnData& adminContentPtr, char *buffer);

   DT_DLL_vrfmsgs const char *decode(DtRwSpawnData& adminContentPtr, const char *buffer);
}