derivedMoveAlongController.h

Go to the documentation of this file.

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

//
//File:        DerivedMoveAlongController.h
//
//Class:       DerivedMoveAlongController
//
#pragma once

#include "vrfmodel/groundMoveAlongControllerComponent.h"

//
//Class Description: DerivedMoveAlongController
//
//The purpose of this class is to demonstrate how to check for and handle
//a situation in which an entity is unable to carry out a given task behavior.
//In this particular example, it extends the DtGroundMoveAlongControllerComponent
//with the ability to determine when it should 'give up' trying to reach its 
//waypoint.  The criteria for determining it should give up trying to complete
//its task is that it should stop trying after 10 seconds.  At that point, it 
//sends a task complete report, indicating it has finished (although it may be
//no where near its destination).
//
//There are 2 required member functions that this class overrides to implement
//the 'give up' behavior:
//
//decideToGiveUpTask() : This is the function that looks at the current
//situation and decides if it should give up.  It will be automatically called
//immediately following the entity's tick().
//
//giveUpTask() : This gets called when the decideToGiveUpTask() returns true.
//In this example, it calls taskComplete(), which results in a task complete
//report being sent and the controller put into a non-tasked state.

class DerivedMoveAlongController : public DtGroundMoveAlongControllerComponent
{
public:

   //constructor
   DerivedMoveAlongController(const DtString& name, 
      DtLocalObject* owner,
      DtSimulationServices* simManager,
      DtComponentDescriptor* desc = NULL,
      DtReaderWriterRegistry* parentRegistry = NULL);

   //destructor
   virtual ~DerivedMoveAlongController() override;

   //Override to initialize myTimeToGiveUp member to current time plus 10 seconds.
   //We'll check this in decideToGiveUp().  Note that this function is only
   //overridden for this particular time-based criteria for giving up.  You would
   //not in general have to override this to add a 'decide to give up' capability
   //to a controller.
   virtual void processMoveAlong(const DtTaskMessage& msg,  DtSimTaskStatePtr taskStatePtr) override;

   //Creates and returns a new DerivedMoveAlongController
   static DtSimComponent* creator(const DtString& name, 
      DtLocalObject* owner,
      DtSimulationServices* simManager,
      DtComponentDescriptor* desc = NULL,
      DtReaderWriterRegistry* parentRegistry = NULL);

protected:

   //Override to see if we should give up after 10 seconds (checks current
   //simulation time against myTimeToGiveUp).  
   virtual bool decideToGiveUpTask() const override;

   //Calls taskComplete().  This will result in a DtTaskComplete report being
   //sent to whomever issued the task.
   virtual void giveUpTask() override;

private:
   //Default constructor; should not be called.  Here because the compiler
   //will generate an unprotected one otherwise.
   DerivedMoveAlongController();

   //copy constructor; shallow; does not copy the ports.
   DerivedMoveAlongController(const DerivedMoveAlongController & 
      orig);

   //assignment operator; see comments on copy constructor!
   const DerivedMoveAlongController & operator=(const 
      DerivedMoveAlongController & orig);

protected:

   //This is the time we decide we want to give up when the entity
   //is executing a task.
   DtTime myTimeToGiveUp;
};