coast_landform.h

Go to the documentation of this file.

 
#ifndef COASTLANDFORM_H
#define COASTLANDFORM_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.
 
===============================================================================================================================*/
#include "cme.h"
#include "2di_point.h"
#include "coast.h"
 
class CACoastLandform
{
private:
 
protected:
   int m_nCoast;

   int m_nPointOnCoast;

   int m_nCategory;

   double m_dTotAccumWaveEnergy;

   CRWCoast* pCoast;
 
public:
   CACoastLandform(void);
   virtual ~CACoastLandform(void);
 
   int nGetCoast(void) const;
   int nGetPointOnCoast(void) const;
//    void SetLandFormCategory(int const);
   int nGetLandFormCategory(void) const;
   CGeom2DIPoint* pPtiGetCellMarkedAsLF(void) const;
//    void SetTotAccumWaveEnergy(double const);
   void IncTotAccumWaveEnergy(double const);
   double dGetTotAccumWaveEnergy(void) const;
 
   // Pure virtual function, makes this an abstract class TODO Derived classes need to instantiate this, even tho' their implementation never uses their instantiation and never gets called. Seems a waste of time. Alternative?
   virtual void Display() = 0;
};
#endif // COASTLANDFORM_H