stateMsgHLA.h

Go to the documentation of this file.

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



#ifndef hDtStateMsg_H_
#define hDtStateMsg_H_

#if DtHLA 


#include <vlutil/vlTimeStampType.h>

#include <vlutil/vlString.h>
#include <vlutil/vlTime.h>
#include "rtiNamespace.h"


class DT_DLL_VL DtHlaObject;
class DT_DLL_VL DtExerciseConn;



class DT_DLL_VL DtStateMsg
{
public:


   DtStateMsg(
      objHandle id,
      const HandleValueMap& attrs
      );

   DtStateMsg(
      objHandle id,
      HandleValueMap* attrs
      );


   virtual ~DtStateMsg();

   DtStateMsg(const DtStateMsg& orig);

   DtStateMsg& operator=(const DtStateMsg& orig);

   virtual objHandle objectId() const;

   virtual const HandleValueMap& handleMap() const;

   virtual HandleValueMap* handleMap();

#if DtHLA_1516

   virtual void setTag(const RTI::VariableLengthData& tag);
   virtual void setCustomTag(const RTI::VariableLengthData& tag);
   virtual const RTI::VariableLengthData& tag() const;  

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

      virtual RTI::FederateHandle producingFederateHandle() const;

      virtual const DtString& producingFederateName(DtExerciseConn* exConn) const;
   #endif

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

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

   virtual void setTag(const DtString& tag);
   virtual void setCustomTag(const DtString& tag);
   virtual const DtString& tag() const;  

#endif

   virtual bool customTagSet() const;

   virtual void print(DtExerciseConn* exConn, 
      RTI::ObjectClassHandle h) const;

   virtual void printToStream(std::ostream& stream,DtExerciseConn* exConn, 
      RTI::ObjectClassHandle h) const;

   virtual void printHeader(DtExerciseConn* exConn,
      RTI::ObjectClassHandle classHandle) const;

   virtual void printHeaderToStream(std::ostream& stream, DtExerciseConn* exConn,
      RTI::ObjectClassHandle classHandle) const;

   virtual void printAttrs(DtExerciseConn* exConn,
      RTI::ObjectClassHandle classHandle, int withHex) const;

   virtual void printAttrsToStream(std::ostream& stream, DtExerciseConn* exConn,
      RTI::ObjectClassHandle classHandle, int withHex) const;

   virtual void print(DtHlaObject *obj,
      bool fullReport = true) const;



   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 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


public:

   static void setTagIsAsciiTime(bool val);
   static bool tagIsAsciiTime();

protected:

#if DtHLA_1516
   HandleValueMap* myAvList;
   objHandle myId;
   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
   HandleValueMap* myAvList;
   DtString myTag;
   objHandle myId;
   const RTI::Region* myConveyedRegion;
#endif

   DtTime myTime;
   DtTimeStampType myTimeType;   
   bool myCustomTagSet;

protected:

   static bool theTagIsAsciiTime;
};

inline const HandleValueMap& DtStateMsg::handleMap() const
{
   return *myAvList;
}

inline HandleValueMap* DtStateMsg::handleMap()
{
   return myAvList;
}


inline objHandle DtStateMsg::objectId() const
{
   return myId;
}

#endif
#endif