pStopInter.h

Go to the documentation of this file.

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


#pragma once

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

namespace MAKVrExchange
{

   class DtPortalConnection;


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

      DtPortalStopInteraction();

      virtual ~DtPortalStopInteraction();



      DtDEC_ATTRIBUTE( DtString, OriginatingEntity,          originatingEntity );
      DtDEC_ATTRIBUTE( DtString, ReceivingEntity,            receivingEntity );
      DtDEC_ATTRIBUTE( DtU32,    RequestIdentifier,          requestIdentifier );
      DtDEC_ATTRIBUTE( DtTime,   RealWorldTime,              realWorldTime );
      DtDEC_ATTRIBUTE( DtU32,    Reason,                     reason );

      DtDEC_ATTRIBUTE( bool,     ReflectValues,              reflectValues );

      DtDEC_ATTRIBUTE( bool,     RunInternalSimulationClock, runInternalSimulationClock );

      DtDEC_ATTRIBUTE( bool,     UpdateAttributes,           updateAttributes );

   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:

      DtPortalStopInteraction &operator=( const DtPortalStopInteraction & );

      int operator==( const DtPortalStopInteraction & );

      int operator!=( const DtPortalStopInteraction & );

   }; //end class DtPortalStopInteraction

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

   inline const char *DtPortalStopInteraction::interactionKindName() const
   {
      return "Stop";
   }

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


   /* Doxygen comments for DtDEC_ATTRIBUTE() have been placed here to make the
      above code more readable */


























}