localObjectUpgrader.h

Go to the documentation of this file.

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

#pragma once

#include "vrfobjcore/vrfobjcoreDefines.h"
#include <map>
#include <vector>
#include <string>

class DtLocalObjectManager;
class DtLocalObjectUpgrader;
class DtLocalObject;
class DtTaskStatusEntry;

typedef DtLocalObjectUpgrader* (*DtLocalObjectUpgraderCreatorFcn)(DtLocalObjectManager*);

class DT_DLL_vrfobjcore DtLocalObjectUpgradeHandler
{
public:
   DtLocalObjectUpgradeHandler() {};
   virtual const char* name() const = 0;
   virtual void upgrade(DtLocalObject*) = 0;
};

class DT_DLL_vrfobjcore DtLocalObjectUpgrader
{
public:

   DtLocalObjectUpgrader(DtLocalObjectManager*);

   virtual ~DtLocalObjectUpgrader();

   static DtLocalObjectUpgraderCreatorFcn SetLocalObjectUpgraderCreatorFcn(DtLocalObjectUpgraderCreatorFcn);
   static DtLocalObjectUpgraderCreatorFcn LocalObjectUpgraderCreatorFcn();

   static DtLocalObjectUpgrader* create(DtLocalObjectManager*);

   static DtLocalObjectUpgrader* creator(DtLocalObjectManager*);

   virtual void upgradeObjects(const std::vector<DtLocalObject*>&);

   virtual void addLocalObjectUpgradeHandler(DtLocalObjectUpgradeHandler*);

protected:
   virtual void upgradeObject(DtLocalObject*);

protected:
   DtLocalObjectManager* myLocalObjectManager = nullptr;
   typedef std::map<std::string, DtLocalObjectUpgradeHandler*> LocalObjectUpgradeHandlers;
   LocalObjectUpgradeHandlers myLocalObjectUpgradeHandlers;

   static DtLocalObjectUpgraderCreatorFcn theLocalObjectUpgraderCreatorFcn;
};

class DT_DLL_vrfobjcore DtUpgradeTasksWithoutControllers : public DtLocalObjectUpgradeHandler
{
public:
   DtUpgradeTasksWithoutControllers() {};

   virtual const char* name() const override { return "DtUpgradeTasksWithoutControllers"; };
   virtual void upgrade(DtLocalObject*) override;

protected:
   virtual bool upgradeTask(DtLocalObject*, DtTaskStatusEntry*);

   virtual void taskEntryAdded(DtTaskStatusEntry* newEntry, DtTaskStatusEntry* entryBeingReplaced);
};