timer.h

Go to the documentation of this file.

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


#pragma once

#include <vrfutil/simClock.h>
#include <vlutil/vlList.h>

class DtScheduler;
class DtTimer;

typedef void (*DtTimerCallbackFcn)(DtTimer *timer);

#include "vrfcore/vrfcoreDefines.h"
class DT_DLL_vrfcore DtTimer : public DtListedObj
{

public:

   DtTimer(const unsigned int type, const DtTime fireTime, 
      const DtTimerCallbackFcn callback, void *usr);

   DtTimer(const DtTimer & orig);

   DtTimer & operator=(const DtTimer & orig);

   virtual ~DtTimer();

   virtual bool tick(const DtTime simTime);

   virtual void reset(const DtTime fireTime);

   virtual void cancel();

   virtual void fire();  

   virtual bool fired() const;

   virtual DtTime fireTime()  const;

   virtual unsigned int timerType() const;

   virtual void * usrData();

   virtual bool cancelled() const;

   virtual void setResortPending();
   virtual void clearResortPending();
   virtual bool resortPending() const;

   virtual void setDeleteAfterFire();   
   virtual void clearDeleteAfterFire();

   virtual bool deleteAfterFire() const;

   virtual bool managed() const;

   virtual void setScheduler(DtScheduler * scheduler);

   virtual bool periodIsRealTime() const;

protected:

   DtScheduler *            myScheduler; 
   const DtTimerCallbackFcn myCallback;
   const unsigned int       myType;
   void *                   myUsrData;
   bool                     myFired;
   bool                     myDeleteAfterFire;
   bool                     myCancelled;
   DtTime                   myFireTime;
   bool                     myResortPending;
};