VR-Forces 4.0.4 Class Documentation: include/vrfobjparam/obstructionSensorDesc.h Source File

Go to the documentation of this file.
00001 /*******************************************************************************
00002 ** Copyright (c) 2004 MAK Technologies, Inc.
00003 ** All rights reserved.
00004 *******************************************************************************/
00005 /*******************************************************************************
00006 ** $RCSfile: obstructionSensorDesc.h,v $ $Revision: 1.9 $ $State: Exp $
00007 *******************************************************************************/
00008 
00011 
00014 
00015 #ifndef DtObstructionSensorDescriptor_H_
00016 #define DtObstructionSensorDescriptor_H_
00017 
00018 #include "vrfobjparam/compDesc.h"
00019 #include "vrfutil/rwReal.h"
00020 #include "vrfutil/rwTemplatedList.h"
00021 #include "vrfutil/rwObjType.h"
00022 #include "vrfutil/rwObjectTypeList.h"
00023 #include "vrfutil/rwVectorObstructionTypeList.h"
00024 #include "vrfutil/rwBoolean.h"
00025 
00026 #include <list>
00027 
00028 class DtReaderWriterRegistry;
00029 
00037 #include "vrfobjparam/vrfobjparamDefines.h"
00038 class DT_DLL_vrfobjparam DtObstructionSensorDescriptor : public DtComponentDescriptor
00039 {
00040 public:
00042    DtObstructionSensorDescriptor(const DtString& name, 
00043       DtReaderWriterRegistry* parentRegistry = 0);
00044 
00046    DtObstructionSensorDescriptor(const DtObstructionSensorDescriptor & orig, 
00047       DtReaderWriterRegistry* parentRegistry = 0);
00048 
00050    DtObstructionSensorDescriptor & operator=(
00051       const DtObstructionSensorDescriptor & orig);
00052 
00054    virtual ~DtObstructionSensorDescriptor();
00055 
00058    virtual DtString type() const;
00059 
00062    virtual void setStoppingDistanceFactor(DtReal distance);
00063    virtual DtReal stoppingDistanceFactor() const;
00065 
00068    virtual void setLateralClearance(DtReal distance);
00069    virtual DtReal lateralClearance() const;
00071 
00074    virtual void setObjectTypes(const DtRwObjectTypeList& objectTypes);
00075    virtual DtRwObjectTypeList& objectTypes();
00076    virtual const DtRwObjectTypeList& objectTypes() const;
00078 
00081    virtual void setVectorObstructionTypes(
00082       const DtRwVectorObstructionTypeList& vectorObstructionTypes);
00083    virtual DtRwVectorObstructionTypeList& vectorObstructionTypes();
00084    virtual const DtRwVectorObstructionTypeList& vectorObstructionTypes() const;
00086 
00089    virtual void setCheckObstructionsIfEmbarked(bool);
00090    virtual bool checkObstructionsIfEmbarked() const;
00092 
00094    virtual DtComponentDescriptor* clone(
00095       DtReaderWriterRegistry* parentRegistry = 0) const;
00096 
00098    static DtComponentDescriptor* creator();
00099 
00100 protected:
00102    DtObstructionSensorDescriptor();
00103 
00104 protected:
00106 
00110 
00116    DtRwReal   myLateralClearance;
00117 
00123    DtRwReal   myStoppingDistanceFactor;
00124 
00129    DtRwBoolean myCheckObstructionsIfEmbarked;
00130 
00134    DtRwObjectTypeList myObjectTypes;
00135 
00140    DtRwVectorObstructionTypeList myVectorObstructionTypes;
00141 
00143 };
00144 
00145 #endif
00146 
00147 
00148