ifModifyVrfOverlay.h

Go to the documentation of this file.

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


#pragma once

#include <vrfExtProtocol/simInterfaceContent.h>
#include <vlutil/vlString.h>
#include <vrfExtProtocol/objectType.h>
#include <vlpi/entityIdentifier.h>


#define DtModifyOverlayAll          0x00000000
#define DtModifyOverlayColor        0x00000001
#define DtModifyOverlayParent       0x00000002
#define DtModifyOverlayUserData     0x00000004
#define DtModifyOverlayAttachedTo   0x00000008
#define DtModifyOverlayExtendedData       0x00000010

#include "vrfmsgs/vrfmsgsDefines.h"
class DT_DLL_vrfmsgs DtIfModifyVrfOverlay : public DtSimInterfaceContent
{
public:

   DtIfModifyVrfOverlay();

   virtual ~DtIfModifyVrfOverlay();

   DtIfModifyVrfOverlay(const DtIfModifyVrfOverlay& orig);

   DtIfModifyVrfOverlay& operator=(const DtIfModifyVrfOverlay& orig);

   virtual DtSimInterfaceContent * clone() const;

   virtual int type() const;

   virtual void setObjectIdentifier(const DtEntityIdentifier& objectIdentifier);
   virtual const DtEntityIdentifier & objectIdentifier() const;
   
   virtual int netRepSize() const;
   virtual bool setFromNet(const char* contentBuffer, 
      unsigned contentSize);
   virtual bool setToNet();

   virtual void setUserData(char* userData, int iLen);
   virtual const char* userData() const;
   virtual int userDataLen() const;

   virtual void setExtendedData(const std::map<std::string, std::string>&);
   virtual const std::map<std::string, std::string>& extendedData() const;

   virtual char modificationFlags() const;

   bool modifyColor() const;
   bool modifyParent() const;
   bool modifyUserData() const;
   bool modifyAttachedTo() const;
   bool modifyExtendedData() const;

   virtual void printDataToString(DtString& str);

   static DtSimInterfaceContent* creator();

public:

   virtual void setParentName(const DtString& parentName);
   virtual const DtString& parentName() const;

   virtual void setAttachmentInfo(const DtString& attachName, bool keepExisting);
   virtual const DtString& attachmentName() const;
   virtual bool keepExistingAttachment() const;

   virtual void setColor(int color);
   virtual int color() const;

protected:

   DtEntityIdentifier myObjectIdentifier;

   DtString myParentName;
   DtString myAttachmentName;
   bool  myKeepExistingAttachment;
   int myColor;

   char* myUserData;
   int   myUserDataLen;

   int  myModificationFlags;
   std::map<std::string, std::string> myExtendedData;
};

inline char DtIfModifyVrfOverlay::modificationFlags() const
{
   return myModificationFlags;
}

inline bool DtIfModifyVrfOverlay::modifyColor() const
{
   return ((myModificationFlags == DtModifyOverlayAll) ||
      ((myModificationFlags & DtModifyOverlayColor) != 0));
}

inline bool DtIfModifyVrfOverlay::modifyParent() const
{
   return ((myModificationFlags == DtModifyOverlayAll) ||
      ((myModificationFlags & DtModifyOverlayParent) != 0));
}

inline bool DtIfModifyVrfOverlay::modifyUserData() const
{
   return ((myModificationFlags == DtModifyOverlayAll) ||
      ((myModificationFlags & DtModifyOverlayUserData) != 0));
}

inline bool DtIfModifyVrfOverlay::modifyAttachedTo() const
{
   return ((myModificationFlags == DtModifyOverlayAll) ||
      ((myModificationFlags & DtModifyOverlayAttachedTo) != 0));
}

inline bool DtIfModifyVrfOverlay::modifyExtendedData() const
{
   return ((myModificationFlags == DtModifyOverlayAll) ||
      ((myModificationFlags & DtModifyOverlayExtendedData) != 0));
}