pStartInter.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2006 MaK Technologies, Inc.** All rights reserved.
******************************************************************************/
/*******************************************************************************
* $RCSfile: pStartInter.h,v $ $Revision: 1.20 $ $State:  
$******************************************************************************/
#ifndef pStartInter_H_
#define pStartInter_H_


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

namespace MAKVrExchange {

class DtPortalConnection;


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

   DtPortalStartInteraction();

   virtual ~DtPortalStartInteraction();




   DtDEC_ATTRIBUTE( DtString, OriginatingEntity, originatingEntity );
   DtDEC_ATTRIBUTE( DtString, ReceivingEntity,   receivingEntity );
   DtDEC_ATTRIBUTE( DtU32,    RequestIdentifier, requestIdentifier );
   DtDEC_ATTRIBUTE( DtTime,   RealWorldTime,     realWorldTime );
   DtDEC_ATTRIBUTE( DtTime,   SimulationTime,    simulationTime );
   DtDEC_ATTRIBUTE( DtTimeStampType, RealWorldTimeType, realWorldTimeType);
   DtDEC_ATTRIBUTE( DtTimeStampType, SimulationTimeType, simulationTimeType);

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:

   DtPortalStartInteraction &operator=( const DtPortalStartInteraction & );

   int operator==( const DtPortalStartInteraction & );

   int operator!=( const DtPortalStartInteraction & );

}; //end class DtPortalStartInteraction

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

inline const char *DtPortalStartInteraction::interactionKindName() const
{
   return "Start";
}

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

}

#endif //end #ifndef pStartInter_H_