aggregatedMovementDescriptor.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjparam/actuatorComponentDescriptor.h"
#include "vrfutil/rwTemplatedList.h"

#include <boost/noncopyable.hpp>

class DT_DLL_vrfobjparam DtAggregatedMovementDescriptor
   : public DtActuatorComponentDescriptor
   , boost::noncopyable
{
public:
   class DT_DLL_vrfobjparam MobilityEntry
      : public DtReaderWriter
   {
   public:
      MobilityEntry(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
      MobilityEntry(const MobilityEntry& orig);

      virtual DtString queryName() const;
      virtual double speedFactor() const;
      virtual double priority() const;
   
      virtual const char* readerWriterType() const;

      static const char* theXmlType();

      virtual const char* xmlType() const
      {
         return theXmlType();
      }

   protected:
      DtRwString myQueryName;
      DtRwReal mySpeedFactor;
      DtRwReal myPriority;
   };

   typedef DtRwTemplatedListPtr<MobilityEntry, true> MobilityList;

   static DtComponentDescriptor* creator();

   explicit DtAggregatedMovementDescriptor(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);

   DtAggregatedMovementDescriptor* clone(DtReaderWriterRegistry* parentRegistry = 0) const;

   DtString type() const;

   virtual const MobilityList& mobilityList() const;
   bool clampToGround() const;

   virtual double retrogradeMovementPenalty() const;
   virtual void setRetrogradeMovementPenalty(double distance);

   virtual DtString engineeringObjectQueryName() const;
   virtual void setEngineeringObjectQueryName(const DtString& name);

   virtual DtString engineeringObjectObstacleQueryName() const;
   virtual void setEngineeringObjectObstacleQueryName(const DtString& name);

   virtual DtString movementType() const;
   virtual void setMovementType(const DtString& t);

   virtual double supplyCheckPeriod()const;
   virtual void setSupplyCheckPeriod(const double t);

   virtual double minimumAirborneAltitude()const;
   virtual void setMinimumAirborneAltitude(const double alt);

   virtual double defaultAltitude()const;
   virtual void setDefaultAltitude(const double alt);

protected:
   explicit DtAggregatedMovementDescriptor(
      const DtAggregatedMovementDescriptor& orig, DtReaderWriterRegistry* parentRegistry = 0);

   MobilityList myMobilityList;
   DtRwBoolean myClampToGroundFlag;
   
   DtRwReal myRetrogradeMovementPenalty;   

   DtRwString myEngineeringObjectQueryName;

   DtRwString myEngineeringObjectObstacleQueryName;

   DtRwString myMovementType;

   DtRwReal mySupplyCheckPeriod;

   DtRwReal myMinimumAirborneAltitude;

   DtRwReal myDefaultAltitude;
};