ifGlobalPlanList.h

Go to the documentation of this file.

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



#pragma once

#include "vrfmsgs/vrfmsgsDefines.h"
#include <vrfExtProtocol/simInterfaceContent.h>
#include <vlpi/entityIdentifier.h>
#include <vrfutil/rwUUID.h>
#include <vector>

class DT_DLL_vrfmsgs DtIfGlobalPlanList : public DtSimInterfaceContent
{
public:
   struct GlobalPlansInformation
   {
      GlobalPlansInformation() : uuid(DtUUID::nullUUID()) {}

      DtUUID uuid;
      DtString name;
      DtEntityIdentifier entityId;
      bool isQuickLaunch = false;
      bool isLaunched = false;
      bool showOnQuickLaunchToolbar = false;
      int ordinal = -1;
      DtString icon;
      bool nameChangeOnly = false;
   };

   typedef std::vector<GlobalPlansInformation> GlobalPlans;

public:
   DtIfGlobalPlanList();

   DtIfGlobalPlanList(const DtIfGlobalPlanList & orig);

   const DtIfGlobalPlanList & operator=(const DtIfGlobalPlanList & orig);

   virtual ~DtIfGlobalPlanList() override;

   virtual int type() const override;

   virtual DtSimInterfaceContent * clone() const override;


   virtual void addGlobalPlanInformation(const DtUUID&, const DtString& planName, const DtEntityIdentifier& id,
      bool isQuickLaunch = false, bool showOnQuickLaunchToolbar = false,
      bool isLaunched = false, const DtString& planIcon = "", int ordinal = 0);
   virtual const GlobalPlans& globalPlans() const;


   virtual void addGlobalPlanNameChange(const DtUUID&, const DtString& planName);

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

   virtual void printDataToString(DtString& str) override;

   static DtSimInterfaceContent* creator();

protected:
   GlobalPlans myGlobalPlans;
};