transDiagnosticMessage.h

Go to the documentation of this file.

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


#pragma once

#include <namespace.h>

#include <portal/pControlMessage.h>

namespace MAKVrExchange
{

   class DT_DLL_LIBPORTAL DtTranslationDiagnosticMessage
      : public DtPortalControlMessageTemplate<DtTranslationDiagnosticMessageKind>
   {
   public:

      typedef DtPortalControlMessageTemplate<DtTranslationDiagnosticMessageKind> BaseClassType;

      typedef void (*TranslationDebuggingMessageCallbackType) (
         const DtTranslationDiagnosticMessage& message, void* userData );

   public:

      // Creator.
      static DtPortalMessage* create();

      // CTOR.
      DtTranslationDiagnosticMessage();

      // Copy CTOR.
      DtTranslationDiagnosticMessage( const DtTranslationDiagnosticMessage& m );

      // Virtual DTOR.
      virtual ~DtTranslationDiagnosticMessage();

      // Assignment operator.
      DtTranslationDiagnosticMessage& operator = ( const DtTranslationDiagnosticMessage& m );

      // Computes the encoded size of the message.
      virtual unsigned int netSize() const;

      // Writes the message to the given buffer.
      virtual void writeSelfToBuffer( void* buffer ) const;

      // Reads the message from the given buffer.
      virtual void readSelfFromBuffer( const void* buffer );

      // Prints the contents of the message to the given stream.
      virtual std::ostream& printDataToStream( std::ostream& stream ) const;

      // Add the given callback to be called when message is sent.
      static void addCallback( DtPortalConnection* connection,
         TranslationDebuggingMessageCallbackType callbackFunction, void* userData );

      // Remove the given callback so it's not called when message is sent.
      static void removeCallback( DtPortalConnection* connection,
         TranslationDebuggingMessageCallbackType callbackFunction, void* userData );


      DtDEC_ATTRIBUTE( DtString, ObjectName, objectName );

      DtDEC_ATTRIBUTE( DtString, IncomingState, incomingState );

      DtDEC_ATTRIBUTE( DtString, OutgoingState, outgoingState );


   };

}