soilFactors.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/rwReal.h>
#include <readerWriter/rwString.h>

class DtReaderWriterRegistry;


#include "vrfutil/vrfutilDefines.h"
class DT_DLL_vrfutil DtSoilFactors : public DtReaderWriter
{
protected:

   DtSoilFactors();

public:
   DtSoilFactors(const DtString& soilType, 
      DtReaderWriterRegistry* parentRegistry = NULL, 
      double accelerationFactor = 1.0, double stoppingFactor = 1.0, 
      double maxSpeedFactor = 1.0 );

   DtSoilFactors(const DtSymbolString& soilType, 
      DtReaderWriterRegistry* parentRegistry = NULL, 
      double accelerationFactor = 1.0, double stoppingFactor = 1.0, 
      double maxSpeedFactor = 1.0 );

   virtual ~DtSoilFactors() override;

   DtSoilFactors(const DtSoilFactors& orig, 
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtSoilFactors& operator=(const DtSoilFactors& orig);

   virtual DtSoilFactors* clone(DtReaderWriterRegistry* parentRegistry = NULL) const;

   virtual void setListItem(DtListItem* item);
   virtual DtListItem* listItem();

   virtual const DtSymbolString soilType() const;

   virtual void setAccelerationFactor(DtReal aFactor);
   virtual const DtRwReal& accelerationFactor() const;

   virtual void setStoppingFactor(DtReal sFactor);
   virtual const DtRwReal& stoppingFactor() const;

   virtual void setMaxSpeedFactor(DtReal msFactor);
   virtual const DtRwReal& maxSpeedFactor() const;

   virtual void inheritValues(const DtSoilFactors& orig);

   virtual const char* readerWriterType() const override;

   bool operator==(const DtSoilFactors&) const;

   virtual void putData(DtEnvironmentSP, DtEnvValueSP parent) const override;
   virtual void getData(const DtEnvironmentSP, const DtEnvValueSP value,
      const DtReaderWriter::SearchPaths& searchPaths = DtReaderWriter::SearchPaths(),
      const DtVariableBindingsList& bindings = DtVariableBindingsList()) override;

   static const char* theXmlType();

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

protected:
 
   DtListItem*  myListItem;
   DtRwReal     myAccelerationFactor;
   DtRwReal     myStoppingFactor;
   DtRwReal     myMaxSpeedFactor;
};