VR-Forces 4.0.4 Class Documentation: include/vrfutil/soilFactors.h Source File

Go to the documentation of this file.
00001 /*******************************************************************************
00002 ** Copyright (c) 1999 MaK Technologies, Inc.
00003 ** All rights reserved.
00004 *******************************************************************************/
00005 /*******************************************************************************
00006 ** $RCSfile: soilFactors.h,v $ $Revision: 1.9 $ $State: Exp $
00007 *******************************************************************************/
00008 
00011 
00017 
00018 #ifndef DtSoilFactors_H_
00019 #define DtSoilFactors_H_
00020 
00021 #include "vrfutil/rdrWritr.h"
00022 #include "vrfutil/rwReal.h"
00023 #include "vrfutil/rwString.h"
00024 
00025 class DtReaderWriterRegistry;
00026 
00033 
00034 #include "vrfutil/vrfutilDefines.h"
00035 class DT_DLL_vrfutil DtSoilFactors : public DtReaderWriter
00036 {
00037 protected:
00038 
00041    DtSoilFactors();
00042 
00043 public:
00045    DtSoilFactors(const DtString& soilType, 
00046       DtReaderWriterRegistry* parentRegistry = NULL, 
00047       double accelerationFactor = 1.0, double stoppingFactor = 1.0, 
00048       double maxSpeedFactor = 1.0 );
00049 
00050    DtSoilFactors(const DtSymbolString& soilType, 
00051       DtReaderWriterRegistry* parentRegistry = NULL, 
00052       double accelerationFactor = 1.0, double stoppingFactor = 1.0, 
00053       double maxSpeedFactor = 1.0 );
00054 
00056    virtual ~DtSoilFactors();
00057 
00059    DtSoilFactors(const DtSoilFactors& orig, 
00060       DtReaderWriterRegistry* parentRegistry = NULL);
00061 
00063    DtSoilFactors& operator=(const DtSoilFactors& orig);
00064 
00065    virtual DtSoilFactors* clone(DtReaderWriterRegistry* parentRegistry = NULL) const;
00066 
00068    virtual void setListItem(DtListItem* item);
00069    virtual DtListItem* listItem();
00070 
00072    virtual const DtSymbolString soilType() const;
00073 
00075    virtual void setAccelerationFactor(DtReal aFactor);
00076    virtual const DtRwReal& accelerationFactor() const;
00077 
00078    virtual void setStoppingFactor(DtReal sFactor);
00079    virtual const DtRwReal& stoppingFactor() const;
00080 
00081    virtual void setMaxSpeedFactor(DtReal msFactor);
00082    virtual const DtRwReal& maxSpeedFactor() const;
00083 
00087    virtual void inheritValues(const DtSoilFactors& orig);
00088 
00092    virtual const char* readerWriterType() const;
00093 
00094 protected:
00095  
00096    DtListItem*  myListItem;
00097    DtRwReal     myAccelerationFactor;
00098    DtRwReal     myStoppingFactor;
00099    DtRwReal     myMaxSpeedFactor;
00100 };
00101 
00102 #endif