pActionRequestInter.h

Go to the documentation of this file.

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


#ifndef pActionRequestInter_H_
#define pActionRequestInter_H_


/* VR-Exchange header files */
#include <portal/pBaseInteraction.h> //class DtPortalBaseInteraction

namespace MAKVrExchange {

   class DtPortalConnection;

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

      DtPortalActionRequestInteraction();

      virtual ~DtPortalActionRequestInteraction();



      DtDEC_ATTRIBUTE( DtString,                 OriginatingEntity, originatingEntity );
      DtDEC_ATTRIBUTE( DtString,                 ReceivingEntity,   receivingEntity );
      DtDEC_ATTRIBUTE( DtU32,                    RequestIdentifier, requestIdentifier );
      DtDEC_ATTRIBUTE( DtU32,                    ActionIdentifier,  actionIdentifier );
      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& stream ) const;

   private:

      DtPortalActionRequestInteraction &operator=( const DtPortalActionRequestInteraction& );

      bool operator==( const DtPortalActionRequestInteraction& ) const;

      bool operator!=( const DtPortalActionRequestInteraction& ) const;

   }; //end class DtPortalActionRequestInteraction

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

   inline const char* DtPortalActionRequestInteraction::interactionKindName() const
   {
      return "Data";
   }

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

}

#endif //end #ifndef pActionRequestInter_H_