interactionHLA.h

Go to the documentation of this file.

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

#ifndef interactionHLA_H_
#define interactionHLA_H_

#if DtHLA 



#include "receiveInteractionCbInfo.h"

#include <vlutil/vlTimeStampType.h>
#include <vlutil/vlTime.h>
#include <vlutil/vlString.h>
#include <vl/interClassDesc.h>


class DT_DLL_VL DtInterClassDesc;
class DT_DLL_VL DtExerciseConn;
class DT_DLL_VL DtList;

class DT_DLL_VL DtInteraction
{
public:

   DtInteraction();

   virtual ~DtInteraction();

   DtInteraction(const DtInteraction& orig);

   DtInteraction& operator=(const DtInteraction& orig);

#if DtHLA_1516
   virtual const RTI::ParameterHandleValueMap& phvm() const = 0;
#else
   virtual const RTI::ParameterHandleValuePairSet& phvps() const = 0;
#endif

#if DtHLA_1516
   virtual void setFromPhvm(const RTI::ParameterHandleValueMap& pvList)=0;
#else
   virtual void setFromPhvps(const RTI::ParameterHandleValuePairSet& pvList)=0;
#endif

   virtual void setExConn(DtExerciseConn* exConn, 
                          DtInterClassDesc* classDesc = 0);

   virtual RTI::InteractionClassHandle interactionClassHandle() const;

   virtual char* interactionClassName() const;

   virtual int numParameters() const;

   virtual bool neededByFederation() const;

   virtual void print() const;

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

   virtual void printHeader() const;

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

   virtual void printData() const;

   virtual void printDataToString(DtString& buff) const;

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

   virtual void printParams(bool withHex) const;

   virtual void printParamsToStream(std::ostream& stream, bool withHex) const;

   virtual const char* name() const = 0;

   virtual DtExerciseConn* exerciseConn() const;

   virtual DtInterClassDesc* classDesc() const;

   virtual bool customTagSet() const;


#if DtHLA_1516
   virtual void setCustomTag(const RTI::VariableLengthData& a_tag);
   virtual void setTag(const RTI::VariableLengthData& tag);
   virtual const RTI::VariableLengthData &tag() const;  
#else
   virtual void setCustomTag(const DtString& a_tag);
   virtual void setTag(const DtString& tag);
   virtual const DtString& tag() const;  
#endif

#if DtHLA_1516
   virtual const RTI::RegionHandleSet* conveyedRegion() const;
   virtual void setConveyedRegion(const RTI::RegionHandleSet* sentRegionHandleSet);
#else
   virtual const RTI::Region* conveyedRegion() const;
   virtual void setConveyedRegion(const RTI::Region* region);
#endif

#if DtHLA_1516_EVOLVED
   virtual void setProducingFederateHandle(RTI::FederateHandle federateHandle);

   virtual RTI::FederateHandle producingFederateHandle() const;

   virtual const DtString& producingFederateName() const;
#endif

#if DtHLA_4
   virtual void setTransportationTypeHandle(RTI::TransportationTypeHandle transportationTypeHandle);

   virtual RTI::TransportationTypeHandle transportationTypeHandle() const;
#endif

   virtual void setTimeStamp(DtTime time, 
                             DtTimeStampType type = DtTimeStampRelative);

   virtual DtTime timeStamp() const;    

   virtual DtTimeStampType timeStampType() const;

   virtual DtTime guessTimeValid(DtTime referenceTime) const;

#if DtHLA_1516
   virtual void setFedTime(const RTI::LogicalTime &ft);
#else
   virtual void setFedTime(const RTI::FedTime &ft);
#endif

#if DtHLA_1516
   virtual const RTI::LogicalTime *fedTime() const;
#else
   virtual const RTI::FedTime *fedTime() const;
#endif

#if DtHLA_1516
   virtual void setMessageRetractionHandle(const RTI::MessageRetractionHandle &handle);

   virtual RTI::MessageRetractionHandle messageRetractionHandle() const;
  
#else
   virtual void setEventRetractionHandle(const RTI::EventRetractionHandle &handle);

   virtual RTI::EventRetractionHandle eventRetractionHandle() const;
#endif


public:

   static void setTagIsAsciiTime(bool val);
   static bool tagIsAsciiTime();
  
   static void addCallback(DtExerciseConn* conn,
      const std::vector<DtString>* classes, DtReceiveInteractionCb cb, void* usr,
      DtDDMRegionSP region = DtDDMRegionSP());
   static void removeCallback(DtExerciseConn* conn,
      const std::vector<DtString>* classes, DtReceiveInteractionCb cb, void* usr,
      DtDDMRegionSP region = DtDDMRegionSP());

   static void addCallback(DtExerciseConn* conn,
      const char* className, DtReceiveInteractionCb cb, void* usr,
      DtDDMRegionSP region = DtDDMRegionSP());
   static void removeCallback(DtExerciseConn* conn,
      const char* className, DtReceiveInteractionCb cb, void* usr,
      DtDDMRegionSP region = DtDDMRegionSP());

protected:

   virtual const char* interactionClassToUse(DtExerciseConn* exConn) const;

#if DtHLA_1516
   virtual RTI::ParameterHandleValueMap &privPvList() const;
#else
   virtual RTI::ParameterHandleValuePairSet* privPvList() const;
#endif

   DtInteraction* self() const;

protected:

   DtInterClassDesc* myClassDesc;
   DtExerciseConn* myExConn;
   DtTime myTime;
   DtTimeStampType myTimeType;

#if DtHLA_1516
   RTI::LogicalTime *myFedTime;
   RTI::ParameterHandleValueMap myPvList;
   RTI::MessageRetractionHandle  myRetractionHandle;
   RTI::VariableLengthData myTag;
   const RTI::RegionHandleSet* myConveyedRegion;
#if DtHLA_1516_EVOLVED
      mutable DtString myProducingFederateName;
      RTI::FederateHandle myProducingFederateHandle;
#endif
#if DtHLA_4
      RTI::TransportationTypeHandle myTransportationTypeHandle;
#endif
#else
   DtString myTag;
   RTI::ParameterHandleValuePairSet* myPvList;
   int myPvListMaxSize;
   RTI::FedTime *myFedTime;
   RTI::EventRetractionHandle myRetractionHandle;
   const RTI::Region* myConveyedRegion;
#endif

   bool myCustomTagSet;


protected:

   static bool theTagIsAsciiTime;
};

DT_DLL_VL std::ostream & operator << (std::ostream &str, const DtInteraction &inter);

inline RTI::InteractionClassHandle
   DtInteraction::interactionClassHandle() const
{
   return myClassDesc->handle();
}

inline char* DtInteraction::interactionClassName() const
{
   return (char*) (myClassDesc ? myClassDesc->name() : 0);
}

inline int DtInteraction::numParameters() const
{
   return myClassDesc ? myClassDesc->numParameters() : 0;
}

inline DtInteraction* DtInteraction::self() const
{
   return (DtInteraction*) this;
}

inline DtExerciseConn* DtInteraction::exerciseConn() const
{
   return myExConn;
}

inline DtInterClassDesc* DtInteraction::classDesc() const
{
   return myClassDesc;
}

inline void DtInteraction::printData() const
{
}

inline void DtInteraction::printDataToString(DtString& buff) const
{
}

inline void DtInteraction::printDataToStream(std::ostream& stream) const
{
}

#if DtHLA_1516
inline void DtInteraction::setMessageRetractionHandle(
   const RTI::MessageRetractionHandle &handle)
{
   myRetractionHandle = handle;
}

inline RTI::MessageRetractionHandle DtInteraction::messageRetractionHandle() const
{
   return myRetractionHandle;
}

#else
inline void DtInteraction::setEventRetractionHandle(
   const RTI::EventRetractionHandle &handle)
{
   myRetractionHandle = handle;
}

inline RTI::EventRetractionHandle DtInteraction::eventRetractionHandle() const
{
   return myRetractionHandle;
}
#endif

#endif
#endif