cell_landform.h

Go to the documentation of this file.

 
#ifndef CELL_LANDFORM_H
#define CELL_LANDFORM_H
/* ===============================================================================================================================
   This file is part of CoastalME, the Coastal Modelling Environment.
 
   CoastalME is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
 
   This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 
   You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
===============================================================================================================================*/
class CRWCellLandform
{
 private:
   int m_nCategory;

   int m_nCoast;

   int m_nPointOnCoastline;

   double m_dAccumWaveEnergy;

   union
   {
      struct
      {
         int m_nDummy;
      } m_sBeachData;
 
      struct
      {
         double m_dNotchApexElev;

         double m_dNotchIncision;
 
#ifdef _DEBUG
         unsigned long m_ulCollapseTimestep;
#endif
      } m_sCliffData;
 
   } m_uLFData;
 
 protected:
 public:
   CRWCellLandform();
   ~CRWCellLandform(void);
 
   void SetLFCategory(int const);
   int nGetLFCategory(void) const;
 
   void SetCoast(int const);
   int nGetCoast(void) const;
 
   void SetPointOnCoast(int const);
   int nGetPointOnCoast(void) const;
 
   void SetAccumWaveEnergy(double const);
   void AddToAccumWaveEnergy(double const);
   double dGetAccumWaveEnergy(void) const;
 
   void SetCliffNotchApexElev(double const);
   double dGetCliffNotchApexElev(void) const;
   void SetCliffNotchIncisionDepth(double const);
   void AddToCliffNotchIncisionDepth(double const);
   double dGetCliffNotchIncisionDepth(void) const;
   // void SetCliffRemaining(double const);
   // double dGetCliffRemaining(void) const;
 
#ifdef _DEBUG
   void SetCliffCollapseTimestep(unsigned long const);
   unsigned long ulGetCliffCollapseTimestep(void) const;
#endif
};
#endif // CELL_LANDFORM_H