pTransferControlInteraction.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2012 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <portal/pBaseInteraction.h> //class DtPortalBaseInteraction
#include <portal/vrxRecordSetList.h>

namespace MAKVrExchange
{

   class DtPortalConnection;

   class DT_DLL_LIBPORTAL DtPortalTransferControlInteraction
      : public DtPortalBaseInteraction
   {
   public:

      typedef void (*functionCallback_type) (
         const DtPortalTransferControlInteraction& interaction, void* usr );

   public:

      DtPortalTransferControlInteraction();

      virtual ~DtPortalTransferControlInteraction();


      DtDEC_ATTRIBUTE( DtString, OriginatingEntity, originatingEntity );
      DtDEC_ATTRIBUTE( DtString, ReceivingEntity, receivingEntity );
      DtDEC_ATTRIBUTE( DtU32, RequestIdentifier, requestIdentifier );
      DtDEC_ATTRIBUTE( DtU32, TransferType, transferType );
      DtDEC_ATTRIBUTE( DtString, TransferredEntityID, transferredEntityID );


   public:

      virtual DtU32 numRecordSets() const;

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

      virtual const DtVrxRecordSetList &recordSetList() const;



   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 &str ) const;


   protected:

      DtVrxRecordSetList myRecordSetList;

   private:

      DtPortalTransferControlInteraction &operator=( const DtPortalTransferControlInteraction & );

      int operator==( const DtPortalTransferControlInteraction & );

      int operator!=( const DtPortalTransferControlInteraction & );

   }; //end class DtPortalTransferControlInteraction

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

   inline const char *DtPortalTransferControlInteraction::interactionKindName() const
   {
      return "TransferControl";
   }

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

}