transferControlInteractionHLA.h

Go to the documentation of this file.

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


#ifndef transferControlInteractionHLA_H_
#define transferControlInteractionHLA_H_

#if DtHLA

#include "interactionWithData.h"
#include "vlpi/recordSetList.h"


class DT_DLL_VL DtTransferControlInteraction;
class DT_DLL_VL DtExerciseConn;

typedef void (*DtTransferControlInteractionCb) 
   (DtTransferControlInteraction* inter, void *user);


class DT_DLL_VL DtTransferControlInteraction : public DtInteractionWithEncDec
{
public:
   
   DtTransferControlInteraction();
 
   DtTransferControlInteraction
         (const DtTransferControlInteraction& other);
   
   virtual ~DtTransferControlInteraction();

   DtTransferControlInteraction& operator=
         (const DtTransferControlInteraction& other);

   virtual void printData() const;

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

   virtual void setOriginatingEntityID(const DtEntityIdentifier& entity);
   virtual const DtEntityIdentifier& originatingEntityID() const;

   virtual void setReceivingEntityID(const DtEntityIdentifier &entity);
   virtual const DtEntityIdentifier receivingEntityID() const;

   virtual void setRequestID(DtU32 id);
   virtual DtU32 requestID() const;


   virtual void setTransferType(const DtTransferType type);
   virtual const DtTransferType transferType() const;

   virtual void setTransferredEntityID(const DtGlobalObjectDesignator &);
   virtual const DtGlobalObjectDesignator &transferredEntityID() const;

   virtual void setNumRecordSets(DtU32 number);
   virtual DtU32 numRecordSets() const;

   virtual bool setRecordSet(int index, const DtRecordSet &set);
   virtual const DtRecordSet &recordSet(int index, 
      bool *valid = NULL);

   virtual bool getRecordSet(int index, DtRecordSet& recSet) const;
   
   virtual const DtRecordSetList &recordSetList() const;
   virtual DtRecordSetList *recordSetList();
   
   virtual const char* name() const;

public:
   static DtInteraction* create();

   static void addCallback(DtExerciseConn *conn, 
      DtTransferControlInteractionCb cb, void *usr,
      DtDDMRegionSP region = DtDDMRegionSP());
   static void removeCallback(DtExerciseConn *conn,
      DtTransferControlInteractionCb cb, void *usr,
      DtDDMRegionSP region = DtDDMRegionSP());
    
protected:

   DtEntityIdentifier myOriginatingEnt;
   DtEntityIdentifier myReceivingEnt;
   DtU32 myRequestId;
   DtGlobalObjectDesignator myTransferEntity;
   DtTransferType myTransferType;
   DtRecordSetList myRecordSetList;

};

inline void 
DtTransferControlInteraction::setOriginatingEntityID
   (const DtEntityIdentifier& id)
{
   myOriginatingEnt = id;
}

inline const DtEntityIdentifier &
DtTransferControlInteraction::originatingEntityID() const
{
   return myOriginatingEnt;
}

inline void 
DtTransferControlInteraction::setReceivingEntityID(
      const DtEntityIdentifier &id)
{
   myReceivingEnt = id;
}

inline const DtEntityIdentifier 
DtTransferControlInteraction::receivingEntityID() const
{
   return myReceivingEnt;
}

inline void 
DtTransferControlInteraction::setRequestID(DtU32 id)
{
   myRequestId = id;
}

inline DtU32
DtTransferControlInteraction::requestID() const
{
   return myRequestId;
}

inline void
DtTransferControlInteraction::setTransferType(const DtTransferType type)
{
   myTransferType = type;
}

inline const DtTransferType
DtTransferControlInteraction::transferType() const
{
   return myTransferType;
}

inline void 
DtTransferControlInteraction::setTransferredEntityID(
    const DtGlobalObjectDesignator &id)
{
   myTransferEntity = id;
}

inline const DtGlobalObjectDesignator& 
DtTransferControlInteraction::transferredEntityID() const
{
   return myTransferEntity;
}

inline const DtRecordSetList &
DtTransferControlInteraction::recordSetList() const
{
  return myRecordSetList;
}

inline DtRecordSetList *
DtTransferControlInteraction::recordSetList()
{
  return &myRecordSetList;
}
   
inline const char* 
DtTransferControlInteraction::name() const
{
   return "DtTransferControlInteraction";
}

#endif
#endif