include/bhaveSim/kynapsePSR.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2009 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
* Copyright 2009 Autodesk, Inc.  All rights reserved.
* Use of this software is subject to the terms of the Autodesk license 
* agreement provided at the time of installation or download, or which otherwise
* accompanies this software in either electronic or hard copy form.
*******************************************************************************/

/*******************************************************************************
** $RCSfile: timeKeeperPSR.h,v $ $Revision: 1.2 $ $State: Exp $
*******************************************************************************/

#pragma once

#include <vrfobjcore/processSR.h>
#include <vrfutil/rwString.h>
#include <vrfutil/rwInt.h>
#include <vrfutil/rwReal.h>
#include <vrfutil/rwVector.h>
#include <bhaveSim/bhaveSimDefines.h>

namespace BHAVE
{

const char DtKynapsePSRType[] = "kynapse-psr-type";

class DT_DLL_bhaveSim DtKynapsePSR : public DtVrfProcessStateRepository
{
public:

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

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

   virtual ~DtKynapsePSR();

   DtKynapsePSR& operator=(const DtKynapsePSR& orig);

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

   virtual DtString type() const;


   virtual DtString debugRouteName() const;
   virtual void setDebugRouteName(const DtString& val);


   virtual DtString movementMode() const;
   virtual void setMovementMode(const DtString& mode);
   virtual bool movementModeSpecified() const;

   virtual int taskRouteCurrentPointIndex() const;
   virtual void taskSetRouteCurrentPointIndex(const int currentIndex);
   virtual bool taskRouteCurrentPointIndexSpecified() const;

   virtual DtVector taskWanderCurrentDestination() const;
   virtual void taskWanderSetCurrentDestination(const DtVector & currentDest);
   virtual bool taskWanderCurrentDestinationSpecified() const;

   virtual DtReal taskWanderRemainingTime() const;
   virtual void taskWanderSetRemainingTime(const DtReal & remainingTime);
   virtual bool taskWanderRemainingTimeSpecified() const;

   virtual void getSelf(DtlObjPtr args, const DtFilename& searchPath, const DtVariableBindingsList& variableBindings);

public:

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

protected:
   DtRwString myDebugRouteName;
   DtRwString myMovementModeStr;


   /* Kynapse agent checkpointing: the task and its parameters is already saved ; but 
   for some agent, we need to record additional information */
   

   DtRwVector myTaskWanderCurrentDestination;
   DtRwReal myTaskWanderRemainingTime;
   DtRwInt myTaskPathWayCurrentPointIndex;
};

} //namespace BHAVE