moveAlongTasks.h

Go to the documentation of this file.

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



#pragma once

#include "vrftasks/simTask.h"
#include <readerWriter/rwString.h>
#include <readerWriter/rwInt.h>
#include <readerWriter/rwBoolean.h>
#include <vlutil/vlNetTypes.h>
#include "vrfutil/iteratorBase.h"
#include "vrfutil/rwUUID.h"
#include "vrftasks/rwRouteActionList.h"

#include "vrftasks/vrftasksDefines.h"
class DT_DLL_vrftasks DtMoveAlongTask : public DtSimTask
{

public:

   DtMoveAlongTask();

   DtMoveAlongTask(const DtString & writeName, 
      DtReaderWriterRegistry * parentRegistry = 0);

   DtMoveAlongTask(const DtString & writeName, const DtMoveAlongTask & orig, 
      DtReaderWriterRegistry * parentRegistry = 0);

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

   virtual ~DtMoveAlongTask() override;

   virtual const DtSimTaskMessageType& type() const override;

   virtual DtSimTask * clone(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0) const override;

   virtual DtString stringRep() const override;

   virtual const DtUUID& route() const;

   virtual void setRoute(const DtUUID&);


   virtual void setTraversalDirection(DtIteratorDirection traversalDirection);
   virtual DtIteratorDirection traversalDirection() const;


   virtual void setStartAtClosestPoint(bool startAtClosestPoint);
   virtual bool startAtClosestPoint() const;


   virtual void setSpeed(double v);
   virtual double speed() const;
   virtual bool isSpeedSpecified() const;

   virtual void setContinueFlag(bool flag);
   virtual bool continueFlag() const;

   virtual void setFinalSpeed(const double s);
   virtual double finalSpeed() const;
   virtual bool isFinalSpeedSpecified() const;

   virtual int netRepSize() const override;

   virtual bool setFromNet(const char* contentBuffer, unsigned contentSize) override;

   virtual bool setToNet() override;

   static DtSimTask * creator();

   virtual bool isOneClick() const override
   {
      return true;
   }

protected:

   DtRwUUID myRoute;
   DtRwInt myTraversalDirection;
   DtRwBoolean myStartAtClosestPoint;
   DtRwReal mySpeed;
   DtRwBoolean myContinueFlag;
   DtRwReal myFinalSpeed;
};

class DT_DLL_vrftasks DtMoveAlongRetrogradeTask : public DtMoveAlongTask
{

public:

   DtMoveAlongRetrogradeTask();

   DtMoveAlongRetrogradeTask(const DtString & writeName, 
      DtReaderWriterRegistry * parentRegistry = 0);

   DtMoveAlongRetrogradeTask(const DtString & writeName, const DtMoveAlongRetrogradeTask & orig, 
      DtReaderWriterRegistry * parentRegistry = 0);

   virtual ~DtMoveAlongRetrogradeTask() override;

   virtual const DtSimTaskMessageType& type() const override;

   virtual DtSimTask * clone(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0) const override;

   virtual DtString stringRep() const override;

   static DtSimTask * creator();
};

class DtRouteAction;

class DT_DLL_vrftasks DtMoveAlongWithActionsTask : public DtMoveAlongTask
{

public:

   DtMoveAlongWithActionsTask();

   DtMoveAlongWithActionsTask(const DtString & writeName,
      DtReaderWriterRegistry * parentRegistry = 0);

   DtMoveAlongWithActionsTask(const DtString & writeName, const DtMoveAlongWithActionsTask & orig,
      DtReaderWriterRegistry * parentRegistry = 0);

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

   virtual ~DtMoveAlongWithActionsTask() override;

   virtual const DtSimTaskMessageType& type() const override;

   virtual DtSimTask * clone(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0) const override;

   virtual DtString stringRep() const override;

   static DtSimTask* creator();

   virtual int netRepSize() const override;

   virtual bool setFromNet(const char* contentBuffer, unsigned contentSize) override;

   virtual bool setToNet() override;

   virtual void setTimeOnTarget(double timeOnTarget);
   virtual double timeOnTarget() const;
   virtual bool isTimeOnTargetSpecified() const;

   virtual void setTimeOnTargetPosition(double timeOnTargetPosition);
   virtual double timeOnTargetPosition() const;
   virtual bool isTimeOnTargetPositionSpecified() const;

   virtual void setAbandonTaskIfTimeOnTargetNotAchievable(bool b);
   virtual bool abandonTaskIfTimeOnTargetNotAchievable() const;

   virtual void setHoldPosition(double loiterPosition);
   virtual double holdPosition() const;
   virtual bool isHoldPositionSpecified() const;

   virtual DtRwRouteActionList& routeActions();
   virtual const DtRwRouteActionList& routeActions() const;

   virtual bool isOneClick() const override
   {
      return false;
   }

protected:
   DtRwReal myTimeOnTarget;
   DtRwReal myTimeOnTargetPosition;
   DtRwReal myLoiterPosition;
   DtRwBoolean myAbandonTaskIfTimeOnTargetNotAchievable;
   DtRwRouteActionList myActionList;
 
};