signalInteractionHLA.h

Go to the documentation of this file.

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

#ifndef signalInteractionHLA_H_
#define signalInteractionHLA_H_

#if DtHLA 


#include <vlutil/vlMachineTypes.h>
#include "interactionWithEncDec.h"
#include "hostStructs.h"


class DtSignalInteraction;
class DtExerciseConn;

#ifndef DT_ENUM_LONG_WORD_PORTION
#define DT_ENUM_LONG_WORD_PORTION
enum DtLongWordPortion
{
   DtUpperWord,
   DtLowerWord
};
#endif



typedef void (*DtSignalInteractionCb)
   (DtSignalInteraction* inter, void* usr);

class DT_DLL_VL DtSignalInteraction : public DtInteractionWithEncDec
{
public:
   DtSignalInteraction();

   virtual ~DtSignalInteraction();

   DtSignalInteraction(const DtSignalInteraction& orig);

   DtSignalInteraction& operator=(const DtSignalInteraction& orig);

   virtual void printData() const;

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

   virtual void setRadioId(const DtGlobalObjectDesignator& id);
   virtual const DtGlobalObjectDesignator& radioId() const;

   virtual void setSampleRate(DtU32 rate);
   virtual DtU32 sampleRate() const;

   virtual void setNumSamples(DtU32 count);
   virtual DtU32 numSamples() const;

   virtual void setNumDataBytes(DtU16 len);
   virtual DtU16 numDataBytes() const;

   virtual void setNumDataBits(DtU16 len);
   virtual DtU16 numDataBits() const;

   virtual void setData(const void* data, int numBytes);
   virtual const void* data() const;

   virtual DtU8 dataByte(int byteNum) const;
   virtual void setDataByte(int byteNum, DtU8 data);

   virtual void setTdlType(DtTacticalDataLinkType link);
   virtual DtTacticalDataLinkType tdlType() const;
  
   virtual void setEncodingType(DtEncodingType encoding);
   virtual DtEncodingType encodingType() const;

   virtual DtEncodingClass encodingClass() const;
   virtual void setEncodingClass(DtEncodingClass encodingClass);

   virtual void setTdlMessageCount(DtU16 count);
   virtual DtU16 tdlMessageCount() const;

   virtual void setProtocolId(DtUserProtocol id);
   virtual DtUserProtocol protocolId() const;

   virtual void setDatabaseIndex(DtU32 index);
   virtual DtU32 databaseIndex() const;

   virtual void setDuration(DtU32 duration);
   virtual DtU32 duration() const;

   virtual void setStartOffset(DtU32 offset);
   virtual DtU32 startOffset() const;

   virtual void setStreamTag(unsigned long upper, unsigned long lower);
   virtual void setStreamTag(unsigned long st);
 
   virtual unsigned long streamTag(
      DtLongWordPortion upperLower = DtLowerWord) const;

   virtual const char* name() const;

public:

   static DtInteraction* create();

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

protected:

   DtGlobalObjectDesignator     myHostRadioId;
   DtU16          mySignalDataLength;   
   DtU8*          mySignalData;
   DtTacticalDataLinkType  myTacticalDataLink;
   DtU16          myTDLMessageCount;
   DtUserProtocol myUserProtocolId;
   DtU32          myDatabaseIndex;
   DtU32          myDuration;
   DtU32          myStartOffset;
   DtEncodingType myEncodingType;
   DtEncodingClass myEncodingClass;
   DtU32          mySampleRate;
   DtU32          mySampleCount;

   DtU32   myStreamTagHi;
   DtU32   myStreamTagLo;
};

#endif   //DtHLA

#endif   //DtSignalInteraction_H_