subordinateManager.h

Go to the documentation of this file.

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

#pragma once


#include <vlutil/vlConfig.h> 
#include <map>
#include <vlutil/vlList.h>
#include <vlpi/disEnums.h>
#include "vrfutil/entityIdIntAssociationList.h"
#include "vrfobjcore/keyedVrfObjectIterator.h"
#include "vrfobjcore/keyedVrfObjectIterator.h"

class DtVrfObject;
class DtSimManager;
class DtSubordinateManager;

typedef void (*DtSubordinateManagerCallbackFcn)(
   const DtSubordinateManager& subordinateManager, void* usr);

struct DtSubordinateManagerCallbackInfo
{
   DtSubordinateManagerCallbackFcn myCallbackFunction;
   void* myUserData;
};

#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtSubordinateManager
{
private:
   DtSubordinateManager();

public:
   DtSubordinateManager(DtSimManager* simObjectManager);

   DtSubordinateManager(const DtSubordinateManager& orig);

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

   virtual ~DtSubordinateManager();

   virtual DtSubordinateManager* clone() const;


   virtual bool addSubordinate(DtVrfObject* subordinate, int designator = 0);

   virtual bool addSubordinateBefore (DtVrfObject* subordinate, 
      DtVrfObject* beforeObject, int designator = 0);

   virtual bool addSubordinateAfter (DtVrfObject* subordinate, 
      DtVrfObject* afterObject, int designator = 0);

   virtual void removeSubordinate(DtVrfObject* subordinate);

   virtual void removeAllSubordinates();

   virtual int numSubordinates() const;

   virtual void resetDesignatorsToSubordinateOrder();

   virtual DtVrfObject* firstSubordinate() const;
   virtual DtVrfObject* lastSubordinate() const;

   virtual bool isSubordinate(const DtEntityIdentifier& id) const;
   virtual bool isSubordinate(DtVrfObject* simObj) const;

   const DtKeyedVrfObjectIterator& iterator() const;

   virtual int designatorForSubordinate(DtVrfObject* subordinate) const;
   virtual int designatorForSubordinate(const DtEntityIdentifier& id) const;

   virtual DtVrfObject* subordinateForDesignator(int designator) const;

   virtual bool setDesignator(const DtEntityIdentifier& id, int designator);
   virtual bool setDesignator(DtVrfObject* subordinate, int designator);

   virtual int firstAvailableDesignator(int start = 1) const;

   virtual int maxUsedDesignator() const;

   virtual void reorderToDesignatorOrder();

   virtual void designatorOrderedList(std::vector<DtEntityIdentifier>&
      designatorOrderedList) const;

   virtual void setSubordinateOrder(const std::vector<DtEntityIdentifier>&
      orderedList);

   virtual void addSubordinatesChangedCallback(
      DtSubordinateManagerCallbackFcn fcn, void* userData);

   virtual void removeSubordinatesChangedCallback(
      DtSubordinateManagerCallbackFcn fcn, void* userData);

   virtual int nextAvailableDesignator(int cur = 0) const;

protected:
   void copySubordinateList(const DtList& list);
   void emptySubordinateList();

   DtListItem* findSubordinateItem(const DtEntityIdentifier& id) const;

   virtual void invokeSubordinatesChangedCallbacks() const;

protected:
   DtSimManager * mySimObjectManager;
   DtKeyedVrfObjectIterator* myIterator;
   DtList mySubordinateList;
   DtEntityIdIntAssociationList myDesignatorTable;

   std::vector<DtSubordinateManagerCallbackInfo> mySubordinatesChangedCallbackList;
};