vrfObjectParameters.h

Go to the documentation of this file.

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



#pragma once

#include <readerWriter/readerWriter.h>
#include <readerWriter/rwObjectType.h>
#include "vrfutil/rwBoundingVolume.h"
#include "vrfobjparam/vrfObjectParameterFactory.h"
#include "vrfutil/rwFormationType.h"
#include "vrfutil/rwBoundingGeometryType.h"
#include "vrfutil/rwForceType.h"
#include "vrfutil/rwVisualMetaData.h"
#include <readerWriter/rwReal.h>
#include <readerWriter/rwBoolean.h>
#include "vrfutil/rwAppearance.h"
#include "vrfutil/rwEntityType.h"
#include <readerWriter/rwString.h>
#include "vrfutil/simClock.h"
#include "vrfutil/rwDeadReckonTypes.h"
#include "vrfutil/rwNavigationParameters.h"
#include "vrfobjparam/rwDeadReckonThresholds.h"
#include "vrfobjparam/componentDescriptorList.h"
#include "vrfutil/vrfSubObjectParameterList.h"
#include "vrfobjparam/connectionDescriptorList.h"
#include "vrfutil/simResourceManager.h"
#include "vrfutil/rwSensorSignatureList.h"
#include "vrfobjparam/simSector.h"
#include "vrfobjparam/radioDescriptorList.h"
#include "vrfobjparam/componentSystemDescriptorList.h"
#include <list>
#include <readerWriter/readerWriterFile.h>
#include "vrfobjparam/taskExecutionRules.h"
#include "vrfutil/rwAutoConnection.h"
#include <readerWriter/rwProperties.h>
#include "vrfobjparam/simArtPartDescriptorList.h"

class DtSimResource;
class DtVrfObjectSubComponentTypes;
class DtFilename;
class DtVrfStateRepositoryUserExtension;
class DtRadioDescriptorList;
class DtSimArtPartDescriptor;
class DtComponentDescriptor;

#include "vrfobjparam/vrfobjparamDefines.h"
class DT_DLL_vrfobjparam DtVrfObjectParameters : public DtReaderWriter
{

public:
   typedef DtRwTemplatedListPtr<DtRwAutoConnection,true> DtAutoConnectionsListPtr;

   DtVrfObjectParameters(const DtString& name = DtString::nullString(), 
      DtReaderWriterRegistry* parentRegistry = NULL, DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);
   DtVrfObjectParameters(const DtSymbolString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL, DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);

   virtual ~DtVrfObjectParameters();

protected:
   DtVrfObjectParameters(const DtVrfObjectParameters& orig,
      const DtString& name = DtString::nullString(), 
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtVrfObjectParameters(const DtVrfObjectParameters& orig,
      const DtSymbolString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL);

public:
   DtVrfObjectParameters& operator=(const DtVrfObjectParameters& orig);

   virtual DtVrfObjectParameters* clone(
      const DtString& name = DtString::nullString(), 
      DtReaderWriterRegistry* parentRegistry = NULL) const;

   virtual DtVrfObjectParameters* clone(
      const DtSymbolString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL) const;

   virtual bool init();

   virtual DtString type() const;

   virtual bool inheritValues(const DtVrfObjectParameters * benefactor);

   virtual void inheritValuesFromThisType(
      const DtVrfObjectParameters * benefactor);

   virtual bool createLocalSubComponentTypes();

   virtual bool createRemoteSubComponentTypes();

   virtual DtVrfObjectSubComponentTypes * localVrfSubComponentTypes() const;

   virtual DtVrfObjectSubComponentTypes * remoteVrfSubComponentTypes() const;

   virtual void setMinTickPeriod(DtReal minTickPeriod);

   virtual DtReal minTickPeriod() const;

    virtual void setMinTickPeriodVariance(DtReal minTickPeriodVariance);

   virtual DtReal minTickPeriodVariance() const;

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

   virtual bool hasGuiKeyword(const DtString&) const;

   virtual const DtString& category() const;
 
   virtual void setCategory(const DtString& category);

   virtual bool categorySpecified() const;

   virtual const DtString& echelonLevel() const;

   virtual void setEchelonLevel(const DtString& echelonLevel);

   virtual bool echelonLevelSpecified() const;

   virtual bool organized() const;

   virtual void setOrganized(bool organized);


   virtual const DtComponentSystemDescriptorList& systemDescriptorList() const;
   virtual DtComponentSystemDescriptorList& systemDescriptorList();
   virtual void setSystemDescriptorList(const DtComponentSystemDescriptorList& list);

   virtual const DtRwVisualMetaData& visualMetaData() const;
   virtual void setVisualMetaData(const DtRwVisualMetaData& 
      list);

   virtual const DtComponentDescriptorList& sensorDescriptorList() const;
   virtual DtComponentDescriptorList& sensorDescriptorList();
   virtual void setSensorDescriptorList(const DtComponentDescriptorList& list);

   virtual const DtComponentDescriptorList& controllerDescriptorList() const;
   virtual DtComponentDescriptorList& controllerDescriptorList();
   virtual void setControllerDescriptorList(const DtComponentDescriptorList& 
      list);

   virtual const DtComponentDescriptorList& actuatorDescriptorList() const;
   virtual DtComponentDescriptorList& actuatorDescriptorList();
   virtual void setActuatorDescriptorList(const DtComponentDescriptorList& 
      list);

   virtual const DtConnectionDescriptorList& connectionDescriptorList() const;
   virtual DtConnectionDescriptorList& connectionDescriptorList();
   virtual void setConnectionDescriptorList(const DtConnectionDescriptorList& 
      list);

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

   virtual const DtRwNavigationParameters& navigationParameters() const;
   virtual DtRwNavigationParameters& navigationParameters();
   virtual void setNavigationParameters(const DtRwNavigationParameters& parameters);


   virtual const DtRwBoolean deadReckoningAllowGuiOverrides() const;
   virtual void setDeadReckoningAllowGuiOverrides(bool allow); 

   virtual const DtRwDeadReckonThresholds& deadReckoningThresholds() const;
   virtual void setDeadReckoningThresholds(const DtRwDeadReckonThresholds&
      deadReckoningThresholds);

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


   virtual const DtRadioDescriptorList& radioDescriptorList() const;
   virtual DtRadioDescriptorList& radioDescriptorList();

   virtual const DtRwSensorSignatureList& sensorSignatureList() const;
   virtual DtRwSensorSignatureList& sensorSignatureList();

   virtual const DtVrfSubObjectParameterList& subordinateObjects() const;
   virtual void setSubordinateObjects(
      const DtVrfSubObjectParameterList& subordinateObjects);

   virtual const DtVrfSubObjectParameterList& attachedObjects() const;
   virtual void setAttachedObjects(
      const DtVrfSubObjectParameterList& attachedObjects);
 
   virtual DtVrfObjectSubComponentTypes * localSubComponentTypes() const;

   virtual DtVrfObjectSubComponentTypes * remoteSubComponentTypes() const;

   virtual void putData(std::string& fp, int indentLevel = 0);

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

   virtual const Dt3dBoundingVolume * boundingVolume() const;

   virtual void setBoundingVolume(const Dt3dBoundingVolume& newBoundingVolume);
   
   virtual void setBoundingVolume(const DtVector& localBvolDiagonal, 
      const DtVector& offset = DtVector::zero());
   
   virtual DtSimBoundingGeometry::DtSimBoundingGeometryType 
      boundingGeometryType() const;
   virtual void setBoundingGeometryType(
      DtSimBoundingGeometry::DtSimBoundingGeometryType type); 

   virtual double draft() const;

   virtual DtAggregateFormation formation() const;
   virtual void setFormation(DtAggregateFormation formation);

   virtual DtU32 appearance() const;
   virtual void setAppearance(const DtU32 appearance);
   virtual bool appearanceSpecified() const;

   virtual const DtString& displayName() const;
   virtual void setDisplayName(const DtString& s);

   virtual const DtEntityType& defaultEntityType() const;
   virtual void setDefaultEntityType(const DtEntityType& s);

   virtual const DtString& displayDescription() const;
   virtual void setDisplayDescription(const DtString& s);

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

   virtual const DtSimResourceManager& resourceManager() const;
   virtual void setResourceManager(const DtSimResourceManager& resourceManager);

   virtual void setStateRepositoryUserExtensionType(const DtString& type);
   virtual const DtString& stateRepositoryUserExtensionType() const;

   virtual DtObjectType objectType() const;
   virtual void setObjectType(const DtObjectType& objectType);

   virtual DtObjectType matchType() const;
   virtual void setMatchType(const DtObjectType& objectType);

   virtual bool taskedBySuperiorUponTaskComplete() const;
   virtual void setTaskedBySuperiorUponTaskComplete(bool trueOrFalse);

   virtual void setRangeRingPublisherTickTime(double);
   virtual double rangeRingPublisherTickTime() const;

   static DtVrfObjectParameters * createParameters(DtlObjPtr mtlStream,
      const DtReaderWriter::SearchPaths& searchPaths, const DtVariableBindingsList& variableBindings, 
      DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);
   static DtVrfObjectParameters * createParameters(const char* name, 
      DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);

   static DtVrfObjectParameterFactory * factory();

   static void setFactory(DtVrfObjectParameterFactory * factory);

   static void addParameterCreatorFcn(const DtString & type, 
      DtSimObjectParametersCreatorFcn fcn);

   static DtVrfObjectParameters * creator(DtEnvironmentSP env, DtEnvValueSP* objectNode);

   void setParameterType(const DtString&);
   const DtString& parameterType() const;

   virtual void setStateRepositoryUserExtension(
      const DtVrfStateRepositoryUserExtension& userExtension);
   virtual DtVrfStateRepositoryUserExtension* stateRepositoryUserExtension() const;

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

   virtual DtTime underFireTime() const;

   virtual void setUnderFireTime(DtTime time);

   virtual bool underFireTimeSpecified() const;

   virtual DtReal underFireDistance() const;

   virtual void setUnderFireDistance(DtReal underFireDistance);

   virtual bool underFireDistanceSpecified() const;


   virtual const DtSimSector& initialSectorOfResponsibility() const;
   virtual void setInitialSectorOfResponsibility(const DtSimSector& sor);


   virtual DtTaskExecutionRules& taskExecutionRules();
   virtual const DtTaskExecutionRules& taskExecutionRules() const;


   virtual void setTaskExecutionRulesFilename(const DtFilename&);
   virtual const DtReaderWriterFile& taskExecutionRulesFilename() const;


   virtual void setHlaFomClass(const DtString&);
   virtual const DtString& hlaFomClass() const;

   virtual void setArtPartList(const DtSimArtPartDescriptorList& partList);
   virtual const DtSimArtPartDescriptorList& artPartList() const;

   virtual const DtAutoConnectionsListPtr& autoConnections() const;
   virtual DtAutoConnectionsListPtr& autoConnections();

   virtual const std::list<DtSimArtPartDescriptor*>* configuredArtPartList() const;

   virtual const std::list<DtSimArtPartDescriptor*>* componentDefaultArtPartList() const;

   virtual void connectSystems();

   bool operator==(const DtVrfObjectParameters&) const;
   bool operator!=(const DtVrfObjectParameters&) const;

   virtual DtEnvironmentSP xmlEnvironment();
   virtual DtEnvValueSP objectNode();

   virtual const DtReaderWriter* findVariableBinding(const DtString&) const;

   virtual const DtVariableBindingsList& variableBindingsFromLoad() const;

   virtual DtReaderWriterRegistryData* findProperty(const DtString& rwName) const;

   virtual const DtRwProperties& parameterData() const;
   virtual DtRwProperties& parameterData();

   virtual const DtRwProperties& stateData() const;
   virtual DtRwProperties& stateData();

   virtual void setPublishParameterData(bool);
   virtual bool publishParameterData() const;

   virtual void setUiFilename(const DtString& uiFilename);
   virtual DtString uiFilename() const;

   virtual void setCanCreateAsNew(bool);
   virtual bool canCreateAsNew() const;

   virtual void setCanMoveOntoEmbarked(bool);
   virtual bool canMoveOntoEmbarked() const;

   virtual void rebuildArtPartList();

   virtual void updatePartOverridesFromActuator(DtSimArtPartDescriptor& artPartDescriptor,
      const DtComponentDescriptor& actuatorDescriptor,
      const DtString& systemName = DtString::nullString());

protected:

   virtual DtVrfSubObjectParameterList* createSubordinateObjectsList(
      const DtSymbolString& name, DtReaderWriterRegistry* parentRegistry) const;

   virtual DtVrfSubObjectParameterList* createAttachedObjectsList(
      const DtSymbolString& name, DtReaderWriterRegistry* parentRegistry) const;

   virtual void addArtPartsFromSystem(DtComponentSystemDescriptor* systemDesc,
      std::list<DtSimArtPartDescriptor*>& artPartList);

   virtual void createAutomaticConnections(DtRwAutoConnection* autoConnection);

   typedef void (*ArtPartDescriptorProcessor)(const DtComponentDescriptor& compDesc,
      DtSimArtPartDescriptor& artPartDesc);

   virtual void addArtPartDescriptorProcessor(const DtString& componentType,
      const ArtPartDescriptorProcessor& fcn);

   static void artPartWeaponDescriptorProcessor(const DtComponentDescriptor& compDesc,
      DtSimArtPartDescriptor& artPartDesc);
   static void artPartHumanGunDescriptorProcessor(const DtComponentDescriptor& compDesc,
      DtSimArtPartDescriptor& artPartDesc);
   static void artPartBallisticGunDescriptorProcessor(const DtComponentDescriptor& compDesc,
      DtSimArtPartDescriptor& artPartDesc);
   static void artPartAzimuthMountDescriptorProcessor(const DtComponentDescriptor& compDesc,
      DtSimArtPartDescriptor& artPartDesc);
   static void artPartElevationMountDescriptorProcessor(const DtComponentDescriptor& compDesc,
      DtSimArtPartDescriptor& artPartDesc);
   static void artPartTurretDescriptorProcessor(const DtComponentDescriptor& compDesc,
      DtSimArtPartDescriptor& artPartDesc);
   static void artPartSensorGimbalDescriptorProcessor(const DtComponentDescriptor& compDesc,
      DtSimArtPartDescriptor& artPartDesc);
   static void artPartSwingingPartDescriptorProcessor(const DtComponentDescriptor& compDesc,
      DtSimArtPartDescriptor& artPartDesc);
   static void artPartTranslatablePartDescriptorProcessor(const DtComponentDescriptor& compDesc,
      DtSimArtPartDescriptor& artPartDesc);

protected:
   
   DtObjectType myMatchType;
   DtObjectType myObjectType;


   DtRwBoundingGeometryType         myBoundingGeometryType;

   DtRwBoundingVolume               myBvol;
   
   DtVrfObjectSubComponentTypes *   myLocalSubComponentTypes;

   DtVrfObjectSubComponentTypes *   myRemoteSubComponentTypes;

   DtRwFormationType                myFormationType;

   DtRwAppearance myDefaultAppearance;

   DtRwForceType             myForceType;

   DtRwString                myCategory;
   
   DtRwString                myEchelonLevel;
   
   DtRwBoolean               myOrganized;

   DtRwReal                  myMinTickPeriod;

   DtRwReal                  myMinTickPeriodVariance;

   DtRwDeadReckonTypes       myDeadReckoningAlgorithm;

   DtRwNavigationParameters myNavigationParameters;

   DtRwDeadReckonThresholds  myDeadReckoningThresholds;

   DtRwBoolean myDeadReckoningAllowGuiOverrides;

   DtRadioDescriptorList   myRadioDescriptorList;

   DtComponentSystemDescriptorList mySystemDescriptorList;

   DtComponentDescriptorList mySensorDescriptorList;

   DtComponentDescriptorList myControllerDescriptorList;

   DtComponentDescriptorList myActuatorDescriptorList;
   
   DtConnectionDescriptorList myConnectionDescriptorList;

   DtRwReal                  myMass;
   
   DtRwSensorSignatureList   mySensorSignatureList;

   DtVrfSubObjectParameterList* mySubordinateObjects;

   DtVrfSubObjectParameterList* myAttachedObjects;
   
   DtRwString                myEngagementRules;

   DtSimResourceManager myResourceManager;
   
   DtRwString                myStateRepositoryUserExtensionType;

   DtRwBoolean               myTaskedBySuperiorUponTaskComplete;

   DtVrfStateRepositoryUserExtension* myStateRepositoryUserExtension;

   DtRwTime                  myUnderFireTime;

   DtRwReal                  myUnderFireDistance;

   DtSimSector myInitialSectorOfResponsibility;

   DtReaderWriterFile myTaskExecutionRulesFilename; 

   DtTaskExecutionRules myTaskExecutionRules;

   DtString                   myParameterType;

   static DtVrfObjectParameterFactory * theFactory;

   std::list<DtSimArtPartDescriptor*> myConfiguredArtPartList;

   std::list<DtSimArtPartDescriptor*> myComponentDefaultArtPartList;

   DtEnvValueSP myObjectNode;
   DtEnvironmentSP myEnvironment;

   DtAutoConnectionsListPtr myAutoConnections;

   DtRwProperties myParameterData;

   DtRwProperties myStateData;

   DtRwReal myRangeRingPublisherTickTime;

   DtRwBoolean       myPublishParameterData;

   DtRwBoolean myIlluminationRecalcTime;  

   DtRwString myDisplayName;  

   DtRwString myDisplayDescription;  

   DtRwString myUiFilename;

   DtRwBoolean myCanCreateAsNew;

   DtRwBoolean myCanMoveOntoEmbarked;

   DtRwString myHlaFomClass;

   DtRwEntityType myDefaultEntityType;

   DtRwVisualMetaData myVisualMetaData;

   DtSimArtPartDescriptorList myArtPartList;

   DtVariableBindingsList myGetSelfVariableBindings;

   typedef std::map<DtString, ArtPartDescriptorProcessor> ArtPartDescProcMap;
   ArtPartDescProcMap myArtPartDescProcs;
};

inline void DtVrfObjectParameters::setParameterType(const DtString& t)
{
   myParameterType = t;
}

inline const DtString& DtVrfObjectParameters::parameterType() const
{
   return myParameterType;
}