include/vrfobjcore/aggregateSpatialModel.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2006 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: aggregateSpatialModel.h,v $ $Revision: 1.7 $ $State: Exp $
*******************************************************************************/



#ifndef DtAggregateSpatialModel_H_
#define DtAggregateSpatialModel_H_

#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjcore/aggregateSpatialData.h"
#include "vrfobjcore/aggregateNode.h"
#include "vrfobjcore/orgViewManagedObjList.h"

#include <vlutil/vlString.h>
#include <vlutil/vlSmartPointers.h>

#include <map>
#include <list>

typedef DtBoost::shared_ptr<DtAggregateData> DtAggregateDataPtr;
typedef DtBoost::shared_ptr<const DtAggregateData> DtAggregateDataConstPtr;

class DtAggregateSpatialData;
class DtExerciseClock;
class DtVrfObjectManager;
class DtOrganizationManagerNode;
class DtVrfObject;
class DtSimBoundingGeometry;

class DT_DLL_vrfobjcore DtAggregateSpatialModel
{
public:

   DtAggregateSpatialModel(DtVrfObjectManager& objectManager, 
      const DtExerciseClock& exerciseClock);

   virtual ~DtAggregateSpatialModel();

   virtual void init();

   virtual void timedTick();

   virtual void setTickPeriodUsesRealTime(bool value);
   virtual bool tickPeriodUsesRealTime() const;

   virtual void setMinTickPeriod(double minTickPeriod);

   virtual double minTickPeriod() const;

   virtual void setMinTickPeriodVariance(double minTickPeriodVariance);

   virtual double minTickPeriodVariance() const;

   virtual void setNextTickTime(double nextTickTime);

   virtual double nextTickTime() const;

   virtual void setTickAsFastAsPossibleWhenPaused(bool yesNo);
   virtual bool tickAsFastAsPossibleWhenPaused() const;

   virtual  DtAggregateSpatialDataConstPtr lookup(
      const DtEntityIdentifier& id) const;

   virtual void printHierarchy() const;

protected:

   virtual double calculateNextTickTime() const;

   virtual void tick();

   virtual void destroyTreesAndMap();

   virtual void buildTreesAndMap();

   virtual void traverseTreesAndUpdateNodes();

   virtual DtAggregateNodePtr createNode(
      const DtOrganizationManagerNode& orgViewNode);

   virtual void updateNode(DtAggregateNodePtr node);

   virtual bool updateNodeData(DtAggregateNodePtr node, 
      const DtAggregateSpatialData& newData);

   virtual bool computeState(DtAggregateNodeConstPtr node, 
      DtAggregateSpatialData& state);

   virtual bool computeOrientation(DtAggregateNodeConstPtr node, 
      DtAggregateNodeList subordinates,
      DtDcm& geocentricOrientation, double& heading);

   virtual bool computeLocationAndBoundingGeometry(
      DtAggregateNodeConstPtr node, 
      DtAggregateNodeList subordinates,
      const DtDcm& geocentricOrientation,
      DtVector& geocentricLocation, 
      DtSimBoundingGeometry& boundingGeometry);

   virtual bool computeVelocity(DtAggregateNodeConstPtr node, 
      DtAggregateNodeList subordinates,
      DtVector& geocentricVelocity);

   virtual void subordinatesToIncludeInComputingState(
      DtAggregateNodeConstPtr node, 
      DtAggregateNodeList& list);

   virtual DtOrgViewManagedObjectListConstPtr subordinatesToIncludeInComputingState(
      DtAggregateNodeConstPtr node) const;

   virtual void processNodeAdded(DtEntityIdentifier eid);

   virtual void processNodeRemoved(DtEntityIdentifier eid);

   virtual void processChildAdded(DtEntityIdentifier eid);

   virtual void processChildRemoved(DtEntityIdentifier eid);

   virtual void registerOrgViewCallbacks();
   void unregisterOrgViewCallbacks();

   virtual void registerAggregateNodeCallbacks(
      DtOrganizationManagerNode& aggregateNode);
   void unregisterAggregateNodeCallbacks(
      DtOrganizationManagerNode& aggregateNode);


   virtual bool organizationHasChanged() const;
   virtual void setOrganizationHasChanged(bool yesNo);

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

public:

   static void nodeAddedCallback(DtEntityIdentifier eid, void* userData);

   static void nodeRemovedCallback(DtEntityIdentifier eid, void* userData);

   static void childAddedCallback(DtEntityIdentifier eid, void* userData);

   static void childRemovedCallback(DtEntityIdentifier eid, void* userData);

private:

   DtAggregateSpatialModel(const DtAggregateSpatialModel& orig);

   DtAggregateSpatialModel& operator=(const DtAggregateSpatialModel& orig);

protected:

   typedef std::map<DtEntityIdentifier, DtAggregateNodePtr> DtAggregateNodeMap;

   DtAggregateNodeMap myNodeMap;
   
   DtAggregateNodeList myRootNodeList;

   const DtExerciseClock& myExerciseClock;

   DtVrfObjectManager& myObjectManager;
   
   bool myOrganizationHasChanged;

   bool myTickPeriodUsesRealTime;
   double myMinTickPeriod;
   double myMinTickPeriodVariance;
   double myNextTickTime;
   double myLastTickSimTime;
   bool myTickAsFastAsPossibleWhenPaused;
};

#endif