tStopInter.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
*********************************************************************/


#ifndef tStopInter_H_
#define tStopInter_H_

#if DtTENA

#include "tInteraction.h"
#include <vlpi/entityIdentifier.h>
#include <vlutil/vlTime.h>


class DT_DLL_VL DtStopFreezeInteraction;

typedef void (*DtStopFreezeInteractionCb)(DtStopFreezeInteraction* inter, void* usr);



class DT_DLL_VL DtStopFreezeInteraction : public DtInteraction
{
public:
   DtStopFreezeInteraction();

   virtual ~DtStopFreezeInteraction();

   DtStopFreezeInteraction(const DtStopFreezeInteraction& orig);

   DtStopFreezeInteraction& operator=(const DtStopFreezeInteraction& orig);

   virtual void setSenderId(const DtEntityIdentifier& id);
   
   virtual const DtEntityIdentifier& senderId() const;

   virtual void setReceiverId(const DtEntityIdentifier& id);
   
   virtual const DtEntityIdentifier& receiverId() const;

   virtual void setRealWorldTime(const DtTime time);
   
   virtual DtTime realWorldTime() const;
   
   virtual void setRequestId(int id);
   
   virtual int requestId() const;

   virtual DtStopReason reason() const; 
   
   virtual void setReason(DtStopReason reason);
    
   virtual bool reflectWhenFrozen() const;
   
   virtual void setReflectWhenFrozen(bool flag);

   virtual bool runClockWhenFrozen() const;

   virtual void setRunClockWhenFrozen(bool flag);

   virtual bool updateWhenFrozen() const;

   virtual void setUpdateWhenFrozen(bool flag);
   
   virtual const char* name() const;

   virtual void printData() const;

   virtual void printDataToStream(std::ostream& stream) const;

public:

   static DtInteraction* create();

   static void addCallback(DtExerciseConn* conn,
      DtStopFreezeInteractionCb cb, void* usr);

   static void removeCallback(DtExerciseConn* conn,
      DtStopFreezeInteractionCb cb, void* usr);


protected:
   DtEntityIdentifier myOrigEnt;
   DtEntityIdentifier myReceiveEnt;
   int                myRequestId;
   DtStopReason       myReason;
   DtTime             myRealTime;
   bool               myReflect;
   bool               myUpdate;
   bool               myRunClock;
};

#endif
#endif