baseTransferControlManager.h

Go to the documentation of this file.

#pragma once

#include <vl/transferControlInteraction.h>
#include <vl/acknowledgeInteraction.h>
#include <vl/setRecordInteraction.h>
#include <vl/eventReportInteraction.h>
#include <map>
#include <list>

class DtExerciseConn;
class DtStateRepository;
class DtRecordSetList;

#ifdef DtDIS
typedef DtTransferControlRequestPduCb DtTransferControlInteractionCb;
typedef DtSetRecordPduCb DtSetRecordInteractionCb;
#endif

struct DtTransferControlCbInfo
{
   DtTransferControlInteractionCb cbFunction;
   void* userData;
};

struct DtAcknowledgementCbInfo
{
   DtAcknowledgeInteractionCb cbFunction;
   void* userData;
};

struct DtSetRecordCbInfo
{
   DtSetRecordInteractionCb cbFunction;
   void* userData;
};

struct DtSetRecordTracker
{
   int totalNumberOfRecords;
   int receivedNumberOfRecords;
   std::set<DtGlobalObjectDesignator> listOfTransferredObjects;
};

class DT_DLL_VL DtBaseTransferControlManager
{
public:

   DtBaseTransferControlManager(DtExerciseConn* exConn);

   ~DtBaseTransferControlManager();

   virtual void addTransferControlNotificationCallback(DtTransferControlInteractionCb usrCallback, void* user);
   virtual void addAcknowledgementNotificationCallback(DtAcknowledgeInteractionCb usrCallback, void* user);
   virtual void addSetRecordNotificationCallback(DtSetRecordInteractionCb usrCallback, void* user);

   virtual void processTransferControlRequest(DtTransferControlInteraction* tci);

   virtual bool processAcknowledge(DtAcknowledgeInteraction* tci);

   virtual void processSetRecord(DtSetRecordInteraction* setRec);

   virtual void sendAcknowledgement(DtU32 requestIdentifier, bool approve, DtRecordSetList* recordSetList = nullptr, DtStateRepository* stateRepo = nullptr);

   virtual void sendSetRecord(DtEntityIdentifier originatingApplicationId, DtU32 requestIdentifier, DtRecordSetList* recordSetList, DtStateRepository* stateRepo);

   virtual unsigned int sendTransferControlRequest(DtTransferControlInteraction* tci);

   virtual unsigned int sendTransferControlRequest(DtEntityIdentifier receivingApplicationId, DtGlobalObjectDesignator transferredEntityId);

   virtual DtTransferControlInteraction* pendingOutgoingTransferRequest(DtU32 requestIdentifier);

   virtual bool getSetRecordTracker(DtU32 requestIdentifier, DtSetRecordTracker& tracker );

   virtual void sendEventReport(DtGlobalObjectDesignator identifier);

   virtual void sendSetRecordInteraction(DtU32 requestIdentifier) = 0;

   virtual void invokeNewAndLostObjectCallbacks() = 0;

   virtual DtU32 findRequestIdForObject(const DtGlobalObjectDesignator& objDesignator);

   virtual bool removeObjectFromTransferredSet(const DtGlobalObjectDesignator& objectDesignator, DtU32 requestId);

   virtual bool isTransferredSetEmpty(DtU32 requestIdentifier) const;

public:

   static void transferControlRequestCallback(DtTransferControlInteraction* tci, void* user);

   static void acknowledgeCallback(DtAcknowledgeInteraction* ack, void* user);
   static void setRecordCallback(DtSetRecordInteraction* setRec, void* user);
   static void postDrainCallback(void* user);

protected:

   virtual void addOutgoingTransferControlRequest(DtTransferControlInteraction* tci);
   virtual void addIncomingTransferControlRequest(DtTransferControlInteraction* tci);
   virtual void removeOutgoingTransferControlRequest(DtGlobalObjectDesignator identifier);
   virtual void removeIncomingTransferControlRequest(DtGlobalObjectDesignator identifier);

private:
   DtBaseTransferControlManager(const DtBaseTransferControlManager& orig);

   DtBaseTransferControlManager& operator=(const DtBaseTransferControlManager& orig);

protected:
   //Pointer to the exercise connection
   DtExerciseConn* myExConn;

   //Callback lists  
   std::list<DtTransferControlCbInfo> myTransferControlNotificationCbList;
   std::list<DtAcknowledgementCbInfo> myAcknowledgementNotificationCbList;
   std::list<DtSetRecordCbInfo> mySetRecordNotificationList;
   
   //Incoming transfer control requests will stay in this map until an acknowledge is sent out
   std::map<DtU32, DtTransferControlInteraction> myIncomingTransferControlRequests;
   //Outgoing transfer control requests will stay in this map until an acknowledge is received.
   std::map<DtU32, DtTransferControlInteraction> myOutgoingTransferControlRequests;

   //Map to track object names and their associated request identifiers.
   std::map<DtGlobalObjectDesignator, DtU32> myObjectIdToRequestIdMap;

   //Map to track SetRecord counts for each request identifier. Allows VR-Link to know when all
   //SetRecord messages for a particular transfer have been received.
   std::map<DtU32, DtSetRecordTracker> mySetRecordTrackerMap;

   //Map of Request Identifiers and the set of related objects to transfer (DIGuy, EmitterBeams, etc)
   std::map<DtU32, std::set<DtGlobalObjectDesignator>> myRequestIdToTransferredObjectListMap;

};