pRadioSignalInter.h

Go to the documentation of this file.

/******************************************************************************
  ** Copyright (c) 1992-2010 VT MAK
 ******************************************************************************/

#ifndef pRadioSignalInter_H_
#define pRadioSignalInter_H_



#include <portal/pBaseInteraction.h> 

namespace MAKVrExchange 
{

   class DtPortalConnection;

   class DT_DLL_LIBPORTAL DtPortalRadioSignalInteraction : public DtPortalBaseInteraction
   {
   public:
      typedef void (*functionCallback_type) (const DtPortalRadioSignalInteraction& interaction, 
                                             void*                                 userData );

      DtPortalRadioSignalInteraction();

      virtual ~DtPortalRadioSignalInteraction();




      DtDEC_ATTRIBUTE( DtString, HostRadioId, hostRadioId );

      DtDEC_ATTRIBUTE( DtU32, DataRate, dataRate );

      DtDEC_ATTRIBUTE( DtU32, Samples, samples );

      DtDEC_ATTRIBUTE( DtVariableLengthData, SignalData, signalData );

      DtDEC_ATTRIBUTE( DtU32, UserProtocolID, userProtocolID );

      DtDEC_ATTRIBUTE( DtU32, TacticalDataLinkType, tacticalDataLinkType );

      DtDEC_ATTRIBUTE( DtU32, DatabaseIndex, databaseIndex );
      DtDEC_ATTRIBUTE( DtU32, Duration, duration );
      DtDEC_ATTRIBUTE( DtU32, StartOffset, startOffset );

   public:

      void setEncodingClass( const DtU32& value );
      DtU32 encodingClass() const;

      void setEncodingType( const DtU32& value );
      DtU32 encodingType() const;

      void setTDLMessageCount( const DtU32& value );
      DtU32 tdlMessageCount() const;

   protected:

      DtU16 myEncodingScheme;


   public:

      static const DtPortalMessageKind theKind;

      //Doxygen comments inherited from parent class
      virtual DtPortalMessageKind kind() const;

      //Doxygen comments inherited from parent class
      virtual const char* interactionKindName() const;

      //Doxygen comments inherited from parent class
      virtual unsigned int netSize() const;

      //Doxygen comments inherited from parent class
      virtual void writeSelfToBuffer( void* buffer ) const;

      //Doxygen comments inherited from parent class
      virtual void readSelfFromBuffer( const void* buffer );

      static void addCallback( DtPortalConnection*    connection, 
                               functionCallback_type  callbackFunction, 
                               void*                  userData );

      static void removeCallback( DtPortalConnection*    connection, 
                                  functionCallback_type  callbackFunction, 
                                  void*                  userData );

      static DtPortalMessage* create();

      //Doxygen comments inherited from parent class
      virtual std::ostream& printDataToStream( std::ostream& stream ) const;

   private:

      DtPortalRadioSignalInteraction& operator=( const DtPortalRadioSignalInteraction& );

      bool operator==( const DtPortalRadioSignalInteraction& ) const;

      bool operator!=( const DtPortalRadioSignalInteraction& ) const;

   }; //end class DtPortalRadioSignalInteraction

   inline DtPortalMessage* DtPortalRadioSignalInteraction::create()
   {
      return new DtPortalRadioSignalInteraction();
   }

   inline const char* DtPortalRadioSignalInteraction::interactionKindName() const
   {
      return "Radio Signal";
   }

   inline DtPortalMessageKind DtPortalRadioSignalInteraction::kind() const
   {
      return theKind;
   }

   inline void DtPortalRadioSignalInteraction::setEncodingClass( const DtU32& value )
   {
      myEncodingScheme |= (0x0000D000 & (value << 14));
   }

   inline DtU32 DtPortalRadioSignalInteraction::encodingClass() const
   {
      return ((myEncodingScheme >> 14) & 0x00000003);
   }


   inline void DtPortalRadioSignalInteraction::setEncodingType( const DtU32& value )
   {
      myEncodingScheme |= (0x00003FFF & value);
   }

   inline DtU32 DtPortalRadioSignalInteraction::encodingType() const
   {
      return (myEncodingScheme & 0x00003FFF);
   }

   inline void DtPortalRadioSignalInteraction::setTDLMessageCount( const DtU32& value )
   {
      setEncodingType( value );
   }

   inline DtU32 DtPortalRadioSignalInteraction::tdlMessageCount() const
   {
      return encodingType();
   }


}

#endif //end #ifndef pRadioSignalInter_H_