turnAndMoveControllerPSR.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2005 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: turnAndMoveControllerPSR.h,v $ $Revision: 1.3 $ $State: Exp $
*******************************************************************************/

#ifndef turnAndMoveControllerPSR_H_
#define turnAndMoveControllerPSR_H_

#include "vrfobjcore/vrfProcessStateRepository.h"
#include "vrfutil/rwInt.h"
#include "vrfutil/rwString.h"

//RW type definition.
const char DtTurnAndMoveControllerPSRType[] = "turn-and-move-process-state-repository";

//DtTurnAndMoveControllerPSR is a process state repository which holds state variables for
//the DtTurnAndMoveController component.
//Process State Repositories hold state data for one or more components so that
//their internal state is preserved when a scenario is saved and reloaded.
class DtTurnAndMoveControllerPSR : public DtVrfProcessStateRepository
{
public:
   //Constructor
   DtTurnAndMoveControllerPSR(DtVrfObject* vrfObject, 
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);
   //Copy constructor
   DtTurnAndMoveControllerPSR(const DtTurnAndMoveControllerPSR& orig, 
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);
   //Assignment Operator
   DtTurnAndMoveControllerPSR& operator=(const DtTurnAndMoveControllerPSR& orig);
   //Destructor
   virtual ~DtTurnAndMoveControllerPSR();

   //Returns complete copy of this class using the copy constructor.
   virtual DtVrfProcessStateRepository* clone(
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0) const;
   //Returns "turn-and-move-process-state-repository"
   virtual DtString type() const;

   //Static creator function for factory registration.
   static DtVrfProcessStateRepository* creator(const DtString& rwName, 
      DtVrfObject* vrfObject, DtReaderWriterRegistry* parentRegistry = 0);

   virtual DtString destinationName() const;
   virtual void setDestinationName(const DtString& newValue);
   
   virtual int subtaskId() const;
   virtual void setSubtaskId(const int& newValue);
  
   virtual int taskState() const;
   virtual void setTaskState(const int& newValue);

protected:
   DtRwString myDestinationName;
   DtRwInt mySubtaskId;
   DtRwInt myTaskState;
};
#endif