obstructionSensorDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: obstructionSensorDesc.h,v $ $Revision: 1.9 $ $State: Exp $
*******************************************************************************/



#ifndef DtObstructionSensorDescriptor_H_
#define DtObstructionSensorDescriptor_H_

#include "vrfobjparam/componentDescriptor.h"
#include "vrfutil/rwReal.h"
#include "vrfutil/rwTemplatedList.h"
#include "vrfutil/rwObjectType.h"
#include "vrfutil/rwObjectTypeList.h"
#include "vrfutil/rwVectorObstructionTypeList.h"
#include "vrfutil/rwBoolean.h"

#include <list>

class DtReaderWriterRegistry;

#include "vrfobjparam/vrfobjparamDefines.h"
class DT_DLL_vrfobjparam DtObstructionSensorDescriptor : public DtComponentDescriptor
{
public:
   DtObstructionSensorDescriptor(const DtString& name, 
      DtReaderWriterRegistry* parentRegistry = 0);

   DtObstructionSensorDescriptor(const DtObstructionSensorDescriptor & orig, 
      DtReaderWriterRegistry* parentRegistry = 0);

   DtObstructionSensorDescriptor & operator=(
      const DtObstructionSensorDescriptor & orig);

   virtual ~DtObstructionSensorDescriptor();

   virtual DtString type() const;

   virtual void setStoppingDistanceFactor(DtReal distance);
   virtual DtReal stoppingDistanceFactor() const;

   virtual void setLateralClearance(DtReal distance);
   virtual DtReal lateralClearance() const;

   virtual void setObjectTypes(const DtRwObjectTypeList& objectTypes);
   virtual DtRwObjectTypeList& objectTypes();
   virtual const DtRwObjectTypeList& objectTypes() const;

   virtual void setFeatureTypesToAvoid(const DtRwStringList& featureTypesToAvoid);
   virtual DtRwStringList& featureTypesToAvoid();
   virtual const DtRwStringList& featureTypesToAvoid() const;

   virtual void setCheckObstructionsIfEmbarked(bool);
   virtual bool checkObstructionsIfEmbarked() const;

   virtual DtComponentDescriptor* clone(
      DtReaderWriterRegistry* parentRegistry = 0) const;

   static DtComponentDescriptor* creator();

protected:
   DtObstructionSensorDescriptor();

protected:


   DtRwReal   myLateralClearance;

   DtRwReal   myStoppingDistanceFactor;

   DtRwBoolean myCheckObstructionsIfEmbarked;

   DtRwObjectTypeList myObjectTypes;
   
   DtRwStringList myFeatureTypesToAvoid;

};

#endif