objectConsoleMessageHandler.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2012 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/



#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrvCore/DtUniqueID.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtUnicode.h>
#include <vlutil/vlPrint.h>
#include <vrfmsgs/ifAskUserQuestion.h>

#include <map>
#include <vector>
#include <boost/signal.hpp>

namespace makVrv
{
   class DtDe;
   class DtSimObjectEntry;
}

class DtEntityIdentifier;
class DtString;
class DtSimMessage;

namespace makVrf
{
   static DtNotifyLevelType DtNlQuestion = DtNotifyLevelType(DtNlDebug + 10);

   class DtNetworkMessageInterface;
   class DtCommentInteractionInterface;

   class DT_DLL_VRFGUICORE DtObjectConsoleMessageHandler : public makVrv::DtVirtualBaseClass
   {
   public:
      typedef std::vector<std::pair<makVrv::DtUnicode, int> > DtConsoleMessageList;

      DtObjectConsoleMessageHandler(makVrv::DtDe&);
      virtual ~DtObjectConsoleMessageHandler();

      static DtObjectConsoleMessageHandler& instance(makVrv::DtDe& de);
      static void registerInstance(makVrv::DtDe& de, DtObjectConsoleMessageHandler*);

      virtual void setEnabled(bool);
      bool enabled() const
      {
         return myEnabled;
      }

      boost::signal<void (const DtEntityIdentifier&, int notifyLevel, const makVrv::DtUnicode&)> signal_consoleMessageReceived;
      boost::signal<void (int)> signal_messageQueueSizeChanged;
      boost::signal<void (makVrv::DtElementID, int, int)> signal_questionStatusChanged;

      virtual void setMessageQueueSize(int);
      int messageQueueSize() const
      {
         return myMessageQueueSize;
      }

      virtual bool questionFor(makVrv::DtElementID id, int questionId, DtIfAskUserQuestion&) const;

      virtual std::vector<int> pendingQuestionsFor(makVrv::DtElementID) const;

      virtual bool hasOutstandingQuestions(makVrv::DtElementID) const;

      virtual DtConsoleMessageList messagesFor(const std::string& entityId) const;

      virtual void setReceivingMessagesFor(makVrv::DtElementID, bool);

      virtual void clearAllMessages(const std::string& entityId);

      virtual void userQuestionAnswered(makVrv::DtElementID id, int questionId);

   protected:
      virtual void processObjectConsoleMessageCallback(DtNetworkMessageInterface*);
      virtual void slot_simObjectEntryAboutToBeRemoved(makVrv::DtSimObjectEntry& entry);

      virtual void processUserQuestion(DtSimMessage*);
      virtual bool processQuestion(const DtIfAskUserQuestion&);
      virtual void processUserQuestionOperation(DtSimMessage*);

      virtual void messagesToResolve();
      virtual void questionsToResolve();

      virtual makVrv::DtUnicode translateComment(DtCommentInteractionInterface* comment) const;
      virtual void messagesToResolve(makVrv::DtElementID);
      virtual void checkIfNeedsToNotifyForNewMessage(makVrv::DtElementID, bool isQuestion = false);

   protected:
      typedef std::map<std::string, DtConsoleMessageList> DtConsoleMessageMap;

      makVrv::DtDe&        myDe;
      bool                 myEnabled;
      int                  myMessageQueueSize;
      DtConsoleMessageMap  myConsoleMessageMap;

      std::map<makVrv::DtElementID, int> myReceivingMessagesFor;

      std::map<std::string, int> myHasAwaitingMessages;
      std::map<std::string, DtIfAskUserQuestion> myHasAwaitingQuestions;

      std::map<makVrv::DtElementID, int> mySetAwaiting;

      typedef std::map<std::string, std::vector<DtIfAskUserQuestion> > PendingQuestions;
      PendingQuestions myPendingQuestions;
   };
}