organizationView.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2003 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: orgView.h,v $ $Revision: 1.17 $ $State: Exp $
*******************************************************************************/



#ifndef DtOrganizationView_H_
#define DtOrganizationView_H_

#include "vrfobjcore/entityIdentifierCallbackInfo.h"
#include "vrfobjcore/vrfObjectPredicate.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"

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

#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtOrganizationView
{
protected:
   DtOrganizationView(const DtOrganizationView& orig);
   DtOrganizationView& operator=(const DtOrganizationView& orig);
public:

   DtOrganizationView(DtVrfObjectManager *objMgr);

   virtual ~DtOrganizationView();

   virtual bool init();


   virtual DtOrganizationManagerNode* lookupNode(
      const DtEntityIdentifier& id) const;

   virtual bool isSubordinateOfTopLevel(
      const DtEntityIdentifier& id) const;

   virtual const DtEntityIdentifier& superior(
      const DtEntityIdentifier& id) const;

   virtual DtVrfObject* superiorVrfObject(const DtEntityIdentifier& id) const;

   virtual bool isSubordinateOf(const DtEntityIdentifier& subordinateId,
      const DtEntityIdentifier& superiorId) const;


   virtual DtOrganizationManagerNode* addEntity(DtVrfObject *vrfObject);

   virtual void removeEntity(DtVrfObject *vrfObject);

   virtual void updateAggregate(DtVrfObject *vrfObject);

   virtual void updateEntity(DtVrfObject *vrfObject);

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


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

   virtual bool isLocal(DtOrganizationManagerNode* node) const;

   virtual void printHierarchy() const;

   virtual DtVrfObjectManager* objectManager();

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

   virtual const DtHashList& nodes() const;

   static bool isTopLevelEntity(const DtEntityType & objectType);


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


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

   virtual void addNodeAddedCallback(
      DtEntityIdentifierCallbackFunction fcn, void* userData);
   virtual void removeNodeAddedCallback(
      DtEntityIdentifierCallbackFunction fcn, void* userData);

   virtual void addNodeRemovedCallback(
      DtEntityIdentifierCallbackFunction fcn, void* userData);
   virtual void removeNodeRemovedCallback(
      DtEntityIdentifierCallbackFunction fcn, void* userData);

protected:
   virtual void processVrfObjectAdded(DtVrfObject *vrfObject);

   virtual void processVrfObjectAboutToBeRemoved(DtVrfObject *vrfObject);

   virtual bool shouldBeAdded(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 void printNode(DtOrganizationManagerNode* node, 
      int indentLevel = 0) const;

   virtual bool networkStateIsDifferentFromLocalState(
      const DtOrganizationManagerNode& node) const;

   virtual void invokeNodeAddedCallbacks(
      const DtEntityIdentifier& entId) const;

   virtual void invokeNodeRemovedCallbacks(
      const DtEntityIdentifier& entId) const;

protected:
   DtVrfObjectManager *myObjectManager;
   DtHashList myTopLevelNodes;
   DtHashList myIdHashList;

   typedef std::list<DtEntityIdentifierCallbackInfo> DtEntityIdentifierCallbackInfoList;

   DtEntityIdentifierCallbackInfoList myNodeAddedCallbackList;
   DtEntityIdentifierCallbackInfoList myNodeRemovedCallbackList;

   DtOrgViewManagedObjectListManager* myManagedObjectListManager;
};

#endif