statisticsReportMessage.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>

#include <broker/frameTimer.h>

namespace MAKVrExchange
{

   class DT_DLL_LIBPORTAL DtStatisticsReportMessage
      : public DtPortalControlMessageTemplate<DtStatisticsReportMessageKind>
   {
   public:

      typedef DtPortalControlMessageTemplate<DtStatisticsReportMessageKind> BaseClassType;

      typedef void (*StatisticsReportMessageCallbackType) (
         const DtStatisticsReportMessage& message, void* userData );

      struct StatisticsField
      {
         StatisticsField( const DtString& name, double val,
               const DtString& unitStr = "", const DtString& descStr = "" )
            : displayName( name )
            , description( descStr )
            , units( unitStr )
            , value( val )
         {
         }

         bool operator < ( const StatisticsField& other ) const
         {
            return ( displayName < other.displayName );
         }

         DtString displayName;
         DtString description;
         DtString units;
         double value;

      };

      typedef std::vector<StatisticsField> FieldEntryVector;

   public:

      // Creator.
      static DtPortalMessage* create();

      // CTOR.
      DtStatisticsReportMessage();

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

      // Virtual DTOR.
      virtual ~DtStatisticsReportMessage();

      // Assignment operator.
      DtStatisticsReportMessage& operator = ( const DtStatisticsReportMessage& 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,
         StatisticsReportMessageCallbackType callbackFunction, void* userData );

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


      DtDEC_ATTRIBUTE( FieldEntryVector, FieldEntries, fieldEntries );

      DtDEC_ATTRIBUTE( DtTime, ReportingInterval, reportingInterval );


   };

}