vrfObjectStateRepository.h

Go to the documentation of this file.

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


#pragma once

#include "vrfobjcore/simObjectStateRepository.h"
#include "vrfobjcore/groundInteractionPt.h"
#include "vrfobjparam/simSector.h"
#include "vrfutil/simResourceManager.h"
#include <vrfExtProtocol/objectType.h>
#include "vrfutil/echelonId.h"
#include "vrfutil/rwInt.h"
#include "vrfobjcore/taskStatusList.h"
#include "vrfutil/rwTemplatedList.h"
#include "vrfobjcore/managedObjectList.h"
#include "vrfobjcore/attachedTerrain.h"
#include "vrfutil/sensorContactInfoList.h"
#include "vrfutil/rwProperties.h"
#include "vrfExtProtocol/rangeItem.h"
#include "vrfobjcore/suspendedTaskInfo.h"
#include "tbb/concurrent_hash_map.h"
#include "tbb/mutex.h"

#include <vlpi/appearance.h>
#include <vlpi/artPartSpec.h>
#include <vlutil/vlString.h>
#include <vlpi/thresholder.h>

#include <vlutil/vlConfig.h>
#include <map>
#include <list>

#include "boost/logic/tribool.hpp"

class DtVrfObjectGeometry;
class DtVrfObject;
class DtVrfObjectParameters;
class DtVrfSubordinateManager;
class DtSimManager;
class DtVrfProcessStateRepositoryManager;
class DtVrfWeaponPSR;
class DtVrfObjectParameters;
class DtRwAppearance;
class DtVrfObject;
class DtVrfObjectParameters;
class DtSimManager;
class DtTaskMessage;
class DtVrfObjectStateRepository;
class DtVrfStateRepositoryUserExtension;
class DtSignatureModifierEvaluator;
class DtAttachmentManager;
class DtArticulatedPartStateRepository;
class DtLegacyProcessStateRepositoryManager;
class DtObjectResourceManager;
class DtSubtaskStatusEntry;
class DtVrfObjectMessage;

const int DtEntityVisibilityTest = 1;
const int DtPolygonVisibilityTest = 2;
const int DtFeatureVisibilityTest = 3;

typedef bool (*DtVisibilityTest)(double rangeSquared, const DtEntityIdentifier& eyeKey,
      const DtVector& localEyePoint, const DtVector& localEndPoint, const DtVrfObjectStateRepository* sr);

typedef void (*DtPostInitializeFromParametersCallbackFcn)(DtVrfObjectStateRepository& stateRepository,
                                                          void* usr);

#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtVrfObjectStateRepository : public DtSimObjectStateRepository
{
protected:
   DtVrfObjectStateRepository();

public:
   typedef std::map<DtString, DtString> ExtendedData;
   typedef std::map<int, DtString> ExtendedLabels;

   DtVrfObjectStateRepository(DtVrfObject* vrfObject, 
      const DtObjectType& objectType, DtVrfObjectParameters* parameters,
      const DtString& rwName = DtString::nullString(),  
      DtReaderWriterRegistry* parentRegistry = 0);

   DtVrfObjectStateRepository(const DtVrfObjectStateRepository& orig,
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);

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

   virtual ~DtVrfObjectStateRepository();

   virtual DtSimObjectStateRepository* clone(
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0) const;

   virtual DtString type() const;

   virtual const int objectStateRepositorySubType() const;

   virtual const int vrfObjectStateRepositorySubType() const;

   virtual bool init();

   virtual bool createParameters();
   virtual void initializeFromParameters();
   virtual const DtVrfObjectParameters* vrfParameters() const;

   virtual DtVrfStateRepositoryUserExtension* userExtension() const;

   virtual void restoreEntity();

   virtual void setExtendedData(const DtString& key, const DtString& value);
   virtual void clearExtendedData();
   virtual void removeExtendedData(const DtString& key);
   virtual DtString extendedData(const DtString& key) const;
   const ExtendedData& extendedDataMap() const
   {
      return myExtendedData;
   }
   virtual void setExtendedDataMap(const ExtendedData&);
   virtual void setExtendedDataMap(const std::map<std::string, std::string>&);

   virtual void setupExtendedDataFromParameterData();

   virtual void setExtendedLabel(int, const DtString& value);
   virtual void clearExtendedLabels();
   virtual DtString extendedLabel(int index) const;
   virtual ExtendedLabels extendedLabels() const;
   virtual void setExtendedLabels(const ExtendedLabels&);

   virtual void setActivity(const DtString&);
   virtual DtString activity() const;


   virtual const DtObjectResourceManager* objectResourceManager() const;
   virtual DtObjectResourceManager* objectResourceManager();


   virtual const DtSimResourceManager& oldResourceManager() const;
   virtual DtSimResourceManager& oldResourceManager();

   virtual DtSimResource* oldLookupResource(const DtString & resourceName);
   virtual const DtSimResource* oldLookupResource(const DtString & resourceName) const;

   virtual void oldAddResource(DtSimResource* resource);

   virtual void oldRemoveResource(DtSimResource* resource);

   virtual void restoreResourcesFromParameters();


   virtual void setSOR(DtReal center, DtReal size);

   virtual DtReal SORSize() const;
   virtual DtReal SORCenter() const;

   virtual const DtSimSector& SOR() const;

   virtual bool inSOR(const DtVrfObject* entity) const;

   virtual const DtString& engagementRules() const;
   virtual void setEngagementRules(const DtString& engagementRules);


   virtual void setRequestTaskNeeded(bool value);
   virtual bool requestTaskNeeded() const;


   virtual void setTasked(const DtString& componentName, bool tasked);
   virtual void setTasked(const DtString& componentName, int taskID, bool tasked);
   virtual bool tasked(const DtString& componentName) const;

   virtual bool isTasked() const;

   virtual void clearCurrentTaskMsg(const DtString& componentName);

   virtual void clearCurrentTaskMsg(const DtString& componentName, int taskId);


   virtual void setCurrentTaskMsg(const DtString& componentName, 
      const DtTaskMessage & taskMsg);

   virtual void setCurrentTaskMsg(const DtString& componentName, 
      const DtTaskMessage & taskMsg, int taskId);

   virtual const DtTaskStatusList* taskStatusList() const;
   virtual DtTaskStatusList* taskStatusList();
   virtual DtSuspendedTaskStatusList* suspendedTaskStatusList();
   
   virtual DtTaskMessage* currentTaskMsg(const DtString& componentName) const;

   virtual DtTaskMessage* currentTaskMsg(const DtString& componentName, int taskId) const;

   virtual std::list<DtTaskMessage*> allCurrentTaskMsg(const DtString& componentName) const;

   virtual void putSelf(FILE* fp, 
                        int indentLevel = 0, 
                        bool writeUnspecified = false,
                        const DtFilename& path = DtReaderWriter::appPath());

   virtual bool placePoints(DtAttachedTerrain& attachedTerrain, 
      std::vector<DtGroundInteractionPt*> groundInteractionPts, 
      bool* terrainDataAvailable = 0);

   virtual void updateSupportPoints(const DtVector& newPosition, 
                                    const DtReal newHeading);


   virtual void setIndependentlyTasked(bool value);
   virtual bool independentlyTasked() const;


   virtual bool processCompleteAttachment(DtVrfObject * vrfObject);
   static void objectAboutToBeRemovedCallback(DtVrfObject * vrfObject, void * usr);
   virtual void processObjectAboutToBeRemovedCallback(DtVrfObject * vrfObject);   

   static DtVrfObjectStateRepository* createRepository(const DtString & name, 
      const DtString & type, DtVrfObject* simObject,
      const DtObjectType & objectType, DtVrfObjectParameters* parameters, 
      DtReaderWriterRegistry* parentRegistry = 0);

   static void addSimObjectStateRepositoryCreatorFcn(const DtString & type, 
      DtSimObjectStateRepositoryCreatorFcn fcn);


   static DtSimObjectStateRepositoryFactory* factory();
   static void setFactory(DtSimObjectStateRepositoryFactory* factory);


   virtual const DtVrfObjectParameters* parameterEntry() const;
   virtual  void setParameterEntry(DtVrfObjectParameters* parameterEntry);

   virtual const DtVrfObjectParameters* parameters() const;

   virtual DtVrfObjectParameters* modifiableParameters();
   virtual void setupParameterInheritance();


   virtual DtForceType forceType() const;
   virtual void setForceType(DtForceType force);

   virtual bool createAttachments();

   void addPart(DtArticulatedPartStateRepository * part);
   void removePart(DtArticulatedPartStateRepository * part);
   DtArticulatedPartStateRepository * part(DtArtPartType partType);

   DtArticulatedPartStateRepository * findDescendantByType(
      DtArtPartType childType);


   virtual bool createAppearance();
   virtual const DtAppearance* appearance() const;
   virtual DtAppearance* appearance();


   virtual void setCapabilities(int cap);
   virtual int capabilities() const;
   

   void setDestroyed(bool isDestroyed);
   bool isDestroyed() const;


   DtReal healthPct() const;
   void setHealthPct(DtReal pct);


   bool firePowerKilled() const;
   void setFirePowerKilled(const bool firePowerKilled);

   bool mobilityKilled() const;
   void setMobilityKilled(const bool mobilityKilled);

   bool flaming() const;
   void setFlaming(const bool flaming);

   bool smoking() const;
   void setSmoking(const bool smoking);

   bool isEntity() const;

   bool isLocal() const;

   bool isAggregate() const;


   virtual DtVrfSubordinateManager* subordinates();
   virtual const DtVrfSubordinateManager* subordinates() const;

   void addSubordinate(DtVrfObject* subordinateEntity);

   void removeSubordinate(DtVrfObject* subordinateEntity);

   virtual DtVrfObject* leadEntity() const;

   virtual const DtString& firstSubordinate() const;

   virtual const DtString& lastSubordinate() const;

   virtual const DtString& firstHealthySubordinate() const;


   virtual DtSimManager* simManager();
   virtual const DtSimManager* simManager() const;


   virtual DtPhysicalWorld* physicalWorld();
   virtual const DtPhysicalWorld* physicalWorld() const;

   virtual void tick();

   virtual void timedTick();
   
   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 double calculateNextTickTime() const;

   virtual bool createSubordinates();
   virtual DtVrfSubordinateManager* vrfSubordinates();
   virtual const DtVrfSubordinateManager* vrfSubordinates() const;

   virtual bool createProcessStateRepositoryManager();

   virtual const DtVrfProcessStateRepositoryManager* 
       systemProcessStateRepositoryManager() const;
   virtual DtVrfProcessStateRepositoryManager* systemProcessStateRepositoryManager();

   virtual const DtTaitBryan& localOrientationWrtDatabase() const;
   virtual void setLocalOrientationWrtDatabase(
      const DtTaitBryan& localOrientation);

   virtual DtVrfWeaponPSR* firstWeaponPSR() const;

   virtual void processObjectGeometry(const DtList& vertices);
   virtual void processObjectGeometry(const DtLocalVertexList& vertices);

   virtual void processObjectGeometry();

   virtual const DtVrfObjectParameters* vrfBaseParameters() const;

   virtual DtGroundInteractionPt* groundCenter();
   virtual const DtGroundInteractionPt* groundCenter() const;

   virtual const DtVector& getPartAttachPoint(const int partType) const;
   
   virtual void place(const DtVector& location, bool* dataAvailable = 0,
      bool requireAllData = false);

   virtual void place(const DtReal heading, bool* dataAvailable = 0,
      bool requireAllData = false);

   virtual void place(const DtVector& location, const DtReal heading, 
      bool clampToGroundFlag = true, bool* dataAvailable = 0,
      bool requireAllData = false);

   virtual void updatePositionFromModelVertices();
   virtual void updateBVolFromModelVertices();


   virtual DtReal mass() const;
   virtual void setMass(const DtReal mass);

   virtual const DtArticulatedPartCollection* artPartList() const;

   virtual void createParts();

   virtual DtTime lastTimeFiredUpon() const;
   virtual void setLastTimeFiredUpon(const DtTime time);

   virtual bool underFire() const;
   virtual void setUnderFire(bool underFire);

   virtual DtDeadReckonTypes deadReckoningAlgorithm() const;
   virtual void setDeadReckoningAlgorithm(
      DtDeadReckonTypes deadReckoningAlgorithm);


   virtual const DtThresholder& deadReckoningThresholder() const;
   virtual void setDeadReckoningThresholder(
      const DtThresholder& thresholder);


   virtual const DtEntityIdentifier & occupyingObjectId() const;
   virtual void setOccupyingObjectId(const DtEntityIdentifier & objId);


   virtual void setEchelonId(const DtEchelonId& echelonId);
   virtual DtEchelonId& echelonId();
   virtual const DtEchelonId& echelonId() const;


   virtual void setIsSubordinateOfForceLevel(bool yesNo);
   virtual bool isSubordinateOfForceLevel() const;

   virtual void putData(FILE *fp, int indentLevel = 0);

   virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings);  

   virtual int nextTaskId();

   virtual int nextSuspendId();



   virtual int spawningTaskId(int subtaskId) const;

   virtual void addPendingSubtaskId(const DtString& componentName, int subtaskId);
   virtual void addPendingSubtaskId(const DtString& componentName, int taskId, int subtaskId);
   virtual bool findPendingSubtaskId(const DtString& componentName, int subtaskId);
   virtual bool findPendingSubtaskId(const DtString& componentName, int taskId, int subtaskId);
   virtual void removePendingSubtaskId(const DtString& componentName, int subtaskId);
   virtual void removePendingSubtaskId(const DtString& componentName, int taskId, int subtaskId);
   virtual void removeAllPendingSubtaskIds(const DtString& componentName);
   virtual void removeAllPendingSubtaskIds(const DtString& componentName, int taskId);
   virtual void printPendingSubtaskIds(const DtString& componentName) const;
   virtual std::vector<int> currentPendingSubstaskIds(const DtString& componentName) const;
   virtual std::vector<int> currentPendingSubstaskIds(const DtString& componentName, int taskId) const;
   virtual DtSubtaskStatusEntry* pendingSubtaskStatus(const DtString& componentName, int subtaskId);
   virtual DtSubtaskStatusEntry* pendingSubtaskStatus(const DtString& componentName, int taskId, int subtaskId);

   virtual DtTaskMessage* pendingSubtask(int subtaskId, DtString& controller) const;

   virtual bool taskedBySuperiorUponTaskComplete() const;

   virtual void setParentWasDestroyedWhenEmbarked(bool);
   virtual bool parentWasDestroyedWhenEmbarked() const;

   virtual void detachFromParent();
   virtual void attachToParent(DtSimObjectStateRepository* parent);
   virtual void attachToParent(DtString parent);

   virtual void addAttachedTerrain(const DtString& parent);

   virtual void removeAttachedTerrain(const DtString& parent);

   Dt3dBoundingVolume* boundingVolume() const;

   DtVector localBoundingVolumeCenterPosition() const;


   DtReal currentSpeed() const;

   DtReal forwardSpeed() const;


   DtReal currentHeading() const;
   void setCurrentHeading(const DtReal heading);


   virtual void addPostInitFromParamsCallback(DtPostInitializeFromParametersCallbackFcn fcn,
      void* usr);
   virtual void removePostInitFromParamsCallback(DtPostInitializeFromParametersCallbackFcn fcn,
      void* usr);

   virtual void restoreStateProperties();

   virtual void initStatePropertiesNotToBeRestored();


   virtual DtRwProperties& stateProperties();
   virtual const DtRwProperties& stateProperties() const;


   virtual DtRwProperties& parameterProperties();
   virtual const DtRwProperties& parameterProperties() const;

protected:

   virtual void initializeNextTaskId();

   virtual void setOrientationRelativeToParent();

   virtual DtAttachedTerrain* createAttachedTerrain();

   virtual DtArticulatedPartStateRepository* createArtPartStateRepository(
      DtVrfObject* vrfObject, const DtObjectType& objectType, 
      const DtString& rwName = DtString::nullString());

public:

   //{@
   virtual void addRangeItem(const DtRangeItem&);
   virtual void removeRangeItem(int index);
   virtual void setRangeItems(const DtRangeItems&);
   const DtRangeItems& rangeItems() const;
   DtRangeItems& rangeItems();
   virtual void clearRangeItems();

   DtAttachedTerrain* terrainAttachedTo() const;

   virtual boost::tribool onTerrainSurface() const;

   virtual double sensorSignature(const DtSymbolString& sensorDomain) const;

   virtual std::list<DtSymbolString> sensorSignatureDomains() const;


   virtual DtSensorContactInfoList& objectContactList();
   virtual const DtSensorContactInfoList& objectContactList() const;

protected:
   virtual double baseSensorSignature(const DtSymbolString& sensorDomain) const;

   virtual double modifySensorSignature(const DtSymbolString& sensorDomain, 
      double baseSignature) const;

   virtual bool initSignatureEvaluators();

   void clearSignatureEvaluators();

   virtual bool createObjectResourceManager();

   virtual void invokePostInitFromParamsCallbacks();

public:

   static void taskCompleteCallback(const DtVrfObjectMessage* msg, void* usr);
   virtual void processTaskComplete(const DtVrfObjectMessage* msg);

   static DtVrfObjectStateRepository * creator(const DtString& name, 
      DtVrfObject* simObject, const DtObjectType& objectType, 
      DtVrfObjectParameters * parameters, 
      DtReaderWriterRegistry * parentRegistry);

   static DtVrfObjectStateRepository* isVrfObjectStateRepository(
      DtSimObjectStateRepository* repository);

   static const DtVrfObjectStateRepository* isVrfObjectStateRepository(
      const DtSimObjectStateRepository* repository);

   virtual DtVrfObjectStateRepository* toVrfObjectStateRepository();
   virtual const DtVrfObjectStateRepository* toVrfObjectStateRepository() const;

protected:

   static bool visibilityFilter(const DtVrfObject * object, void * usr);

protected:

   DtVrfStateRepositoryUserExtension* myStateRepositoryUserExtension;

   DtRwAppearance*          myAppearance;
   DtRwInt                  myCapabilities;

   DtRwForceType            myForceType;

   DtVrfSubordinateManager*    mySubordinates;

   DtRwString myParentName;

   DtVrfProcessStateRepositoryManager* mySystemProcessSRManager;
   DtLegacyProcessStateRepositoryManager* myLegacyPSRManager;

   DtSimManager*              mySimManager;

   DtGroundInteractionPt     myGroundCenter;

   bool                      myUnderFire;
   DtTime                    myLastTimeFiredUpon;
   
   DtReal                    myMass;
   DtDeadReckonTypes         myDeadReckoningAlgorithm;
   DtThresholder             myDeadReckoningThresholder;

   DtEntityIdentifier        myOccupyingObjectId;

   DtArticulatedPartCollection            myArtPartList;

   DtManagedObjectListConstPtr  myVisibilityFilterList;

   DtRwVector                myLocalPosition;
   DtRwTaitBryan             myLocalOrientation; 
   DtRwBoolean               myIsDestroyedFlag;

   DtEchelonId               myEchelonId;
   DtRwBoolean               myIsSubordinateOfForceLevel;

   DtRwInt                   myDesignator;

   DtRwBoolean               myIndependentlyTasked;

   static DtSimObjectStateRepositoryFactory* theFactory;

   DtSimResourceManager      myResourceManager;

   DtObjectResourceManager* myObjectResourceManager;

   DtRwString                myEngagementRules;

   DtSimSector               mySectorOfResponsibility;

   DtRwBoolean myRequestTaskNeeded;

   DtTaskStatusList myTaskStatusList;

   DtSuspendedTaskStatusList mySuspendedTaskStatusList;

   DtRwInt myNextTaskId;
   DtRwInt myNextSuspendId;

   DtRwBoolean myParentWasDestroyedWhenEmbarked;

protected:
   //***** Important API change note
   //*****

   const DtVrfObjectParameters*   myParameterEntry;

   DtVrfObjectParameters*   myParameters;

   double myMinTickPeriod;
   double myMinTickPeriodVariance;
   double myNextTickTime;
   double myLastTickSimTime;

   DtAttachedTerrain* myTerrainAttachedTo;

   typedef std::list<DtSignatureModifierEvaluator*> DtSignatureModifierEvalList;
   typedef std::map<DtSymbolString, DtSignatureModifierEvalList*> DtSignatureModifierEvalMap;
   DtSignatureModifierEvalMap mySignatureModifierEvalMap;

   typedef tbb::concurrent_hash_map<unsigned int, double> DtSensorSignatureCacheMap;
   mutable DtSensorSignatureCacheMap myMutableSensorSignatureCacheMap;

   DtSensorContactInfoList myObjectContactList;

   typedef std::pair<DtPostInitializeFromParametersCallbackFcn, void*> DtPostInitializeFromParametersInfo;
   typedef std::list<DtPostInitializeFromParametersInfo> DtPostInitializeFromParametersCallbackList;

   DtPostInitializeFromParametersCallbackList myPostInitFromParamsCallbackList;

   DtRangeItems myRangeItems;
   std::vector<DtRangeItem> myFixedRangeItems;

   DtRwProperties myStateProperties;
   DtRwProperties myParameterProperties;
   ExtendedData myExtendedData;

   std::vector<DtString> myStatePropertiesNotToBeRestored;

   mutable tbb::mutex myEvaluateSensorSignatureMutex;
};