ifServerMessage.h

Go to the documentation of this file.

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


#pragma once

#include "vrfmsgs/vrfmsgsDefines.h"
#include <vrfExtProtocol/simInterfaceContent.h>


class DT_DLL_vrfmsgs DtIfServerMessage : public DtSimInterfaceContent
{
public:
   enum MessageCategory
   {
      Unknown = 0,
      ScenarioGeneric,
      ScenarioLoad,
      ScenarioSave,
      ScenarioCheckpointSaved,
      UserDefined = 100000
   };

public:

   DtIfServerMessage();

   virtual ~DtIfServerMessage();

   DtIfServerMessage(const DtIfServerMessage& orig);

   DtIfServerMessage& operator=(const DtIfServerMessage& orig);

   virtual int type() const;

   virtual DtSimInterfaceContent * clone() const;

   virtual void setMessage(const std::string&);
   virtual std::string message() const;

   virtual void setMessageCategory(MessageCategory);
   virtual MessageCategory messageCategory() const;

   virtual void setSeverity(int);
   virtual int severity() const;

   virtual void addExtra(const std::string&, const std::string&);
   const std::map<std::string, std::string> extra() const { return myExtra; };
   virtual std::string extraValue(const std::string& key) const;

   virtual int netRepSize() const;
   virtual bool setFromNet(const char* contentBuffer, 
      unsigned contentSize);
   virtual bool setToNet();

   virtual void printDataToString(DtString& str);

   static DtSimInterfaceContent* creator();

protected:
   std::string myMessage;
   MessageCategory myMessageCategory;
   int mySeverity;

   std::map<std::string, std::string> myExtra;
};