organizationView.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjcore/vrfObjectPredicate.h"
#include "vrfobjcore/vrfObjectReference.h"
#include <vlutil/vlList.h>
#include <vlutil/vlHashlist.h>
#include <vl/globalObjectDesignator.h>
#include <vlpi/disEnums.h>
#include <vector>
#include <list>
#include "vrfobjcore/orgViewManagedObjectList.h"
#include <readerWriter/noArgumentCallbackList.h>
#include <boost/unordered_map.hpp>

class DtVrfObjectManager;
class DtOrganizationManagerNode;
class DtVrfObject;
class DtEntityType;
class DtReflectedExtAggregate;
class DtOrgManagerOperation;
class DtSimMessage;
class DtOrgViewManagedObjectListManager;

typedef DtCallbackList<const DtUUID&> DtOrgViewCallbackList;

class DT_DLL_vrfobjcore DtOrganizationView
{
protected:
   DtOrganizationView(const DtOrganizationView& orig);
   DtOrganizationView& operator=(const DtOrganizationView& orig);
public:

   typedef boost::unordered_map<DtUUID, DtOrganizationManagerNode*> UUIDMap;
   typedef boost::unordered_map<int, DtOrganizationManagerNode*> ForceMap;

   DtOrganizationView(DtVrfObjectManager *objMgr);

   virtual ~DtOrganizationView();

   virtual bool init();


   virtual DtOrganizationManagerNode* lookupNode(const DtUUID&) const;

   virtual DtOrganizationManagerNode* lookupNodeByUUID(const DtUUID&) const;

   virtual bool removeNode(const DtUUID&);

   virtual bool isSubordinateOfTopLevel(const DtUUID&) const;

   virtual const DtUUID& superior(const DtUUID&) const;

   virtual DtSharedVrfObjectReference superiorVrfObject(const DtUUID&) const;

   virtual bool isSubordinateOf(const DtUUID& subordinate,
      const DtUUID& superior) const;


   virtual DtOrganizationManagerNode* addEntity(const DtVrfObject *vrfObject);

   virtual void removeEntity(const DtVrfObject *vrfObject);

   virtual void updateAggregate(const DtVrfObject *vrfObject);

   virtual void updateEntity(const DtVrfObject *vrfObject);

   virtual DtOrgViewManagedObjectListConstPtr getList(
      const DtUUID& aggregate,
      const DtVrfObjectPredicate& predicate = 
      DtVrfObjectPredicate::nullPredicate(),
      bool reevaluateFlag = false, DtTime evaluationPeriod = 0.) const;

   virtual DtOrgViewManagedObjectListConstPtr nullList() const;


   virtual DtOrganizationManagerNode* locateSuperiorNodeForGlobalId(
      const DtGlobalObjectDesignator& globalId) const;

   virtual bool isLocal(DtOrganizationManagerNode* node) const;

   virtual void printHierarchy() const;

   virtual void printNode(DtOrganizationManagerNode* node, 
      int indentLevel = 0) const;

   virtual const DtVrfObjectManager* objectManager() const;

   virtual DtSharedVrfObjectReference topLevelObjectForForce(const DtForceType& force) const;
   
   virtual DtOrganizationManagerNode* topLevelNodeForForce(DtForceType force) const;

   virtual const UUIDMap& nodes() const;

   static bool isTopLevelEntity(const DtEntityType & objectType);


   static bool isOrganizedAggregate(const DtVrfObject *vrfObject);
   static bool isOrganizedEntity(const DtVrfObject *vrfObject);


   static void vrfObjectAddedCallback(const DtVrfObject *vrfObject, void* usr);
   static void vrfObjectAboutToBeRemovedCallback(const DtVrfObject *vrfObject, 
      void* usr);   

   virtual void addNodeAddedCallback(
      DtOrgViewCallbackList::DtCallbackFunctionType fcn, void* userData) const;
   virtual void removeNodeAddedCallback(
      DtOrgViewCallbackList::DtCallbackFunctionType fcn, void* userData) const;

   virtual void addNodeRemovedCallback(
      DtOrgViewCallbackList::DtCallbackFunctionType fcn, void* userData) const;
   virtual void removeNodeRemovedCallback(
      DtOrgViewCallbackList::DtCallbackFunctionType fcn, void* userData) const;

   virtual void addNodeAboutToBeRemovedCallback(
      DtOrgViewCallbackList::DtCallbackFunctionType fcn, void* userData) const;
   virtual void removeNodeAboutToBeRemovedCallback(
      DtOrgViewCallbackList::DtCallbackFunctionType fcn, void* userData) const;

   virtual void objectUUIDChanged(const DtUUID& oldUUID, const DtUUID& newUUID);

protected:
   virtual DtOrganizationManagerNode* createOrganizationManagerNode() const;

   virtual void processVrfObjectAdded(const DtVrfObject *vrfObject);

   virtual void processVrfObjectAboutToBeRemoved(const DtVrfObject *vrfObject);

   virtual bool shouldBeAdded(const DtVrfObject *vrfObject) const;

   virtual void findAndConnectNodeParent(DtOrganizationManagerNode* node);

   virtual void disconnectNodeParent(DtOrganizationManagerNode* node);

   virtual void findAndConnectNodeChildren(DtOrganizationManagerNode* node);

   virtual void disconnectNodeChildren(DtOrganizationManagerNode* node);

   virtual void connectNodeToTopLevel(DtOrganizationManagerNode* node,
      bool allowCreation = true);

   virtual bool networkStateIsDifferentFromLocalState(
      const DtOrganizationManagerNode& node) const;

   virtual void invokeNodeAddedCallbacks(const DtUUID&);

   virtual void invokeNodeRemovedCallbacks(const DtUUID&);

   virtual void invokeNodeAboutToBeRemovedCallbacks(const DtUUID&);

   virtual DtOrganizationManagerNode* findNode(DtSharedVrfObjectReference obj) const;

   virtual DtSharedVrfObjectReference findObject(const DtUUID& uuid) const;

protected:
   DtVrfObjectManager *myObjectManager;

   ForceMap myTopLevelNodes;

   UUIDMap myIdHashList;

   mutable DtOrgViewCallbackList myNodeAddedCallbackList;
   mutable DtOrgViewCallbackList myNodeRemovedCallbackList;
   mutable DtOrgViewCallbackList myNodeAboutToBeRemovedCallbackList;

   DtOrgViewManagedObjectListManager* myManagedObjectListManager;
};