pCommentInter.h

Go to the documentation of this file.

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


#pragma once

#include <portal/pBaseInteraction.h>

namespace MAKVrExchange
{

   class DtPortalConnection;

   class DT_DLL_LIBPORTAL DtPortalCommentInteraction
      : public DtPortalBaseInteraction
   {
   public:

      typedef void (*functionCallback_type) (
         const DtPortalCommentInteraction &interaction, void  *userData);

      DtPortalCommentInteraction();

      virtual ~DtPortalCommentInteraction();



      DtDEC_ATTRIBUTE( DtString, SenderId,     senderId );
      DtDEC_ATTRIBUTE( DtString, ReceiverId,   receiverId );
      DtDEC_ATTRIBUTE( DtString, Comment,      comment );
      DtDEC_ATTRIBUTE( DtFixedLengthDataArray,   FixedDatums,       fixedDatums );
      DtDEC_ATTRIBUTE( DtAttributeValuePairList, VariableDatumSet,  variableDatumSet );


   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;

   private:

      DtPortalCommentInteraction &operator=( const DtPortalCommentInteraction & );

      int operator==( const DtPortalCommentInteraction & );

      int operator!=( const DtPortalCommentInteraction & );

   }; //end class DtPortalCommentInteraction

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

   inline const char *DtPortalCommentInteraction::interactionKindName() const
   {
      return "Comment";
   }

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

}