CRWDrift Class Reference

Real-world class used to represent the 'drift' category of coastal landform object. More...

#include <drift.h>

Inherits CACoastLandform.

Public Member Functions
	CRWDrift (CRWCoast *, int const, int const, int const)
	Constructor with four parameters and an intialization list.
	~CRWDrift (void) override
	Destructor.
void	Display (void) override
	Instantiates the pure virtual function in the abstract parent class, so that CRWDrift is not an abstract class.
Public Member Functions inherited from CACoastLandform
	CACoastLandform (void)
	Constructor with initialisation list.
virtual	~CACoastLandform (void)
	Destructor.
int	nGetCoast (void) const
	Get the number of the coast on which this coast landform sits.
int	nGetPointOnCoast (void) const
	Get the point on the coast on which this coast landform sits.
int	nGetLandFormCategory (void) const
	Get the landform category.
CGeom2DIPoint *	pPtiGetCellMarkedAsCliff (void) const
	Get the grid coordinates of the cell on which this cliff sits.
void	IncTotAccumWaveEnergy (double const)
	Increment total accumulated wave energy.
double	dGetTotAccumWaveEnergy (void) const
	Get total accumulated wave energy.

Private Attributes
double	m_dD50
	The drift's d50.

Additional Inherited Members
Protected Attributes inherited from CACoastLandform
int	m_nCoast
	The coast number on which this coast landform sits.
int	m_nPointOnCoastline
	The point on the coast on which this coast landform sits.
int	m_nCategory
	Landform category code.
double	m_dTotAccumWaveEnergy
	Total accumulated wave energy since beginning of simulation.
CRWCoast *	pCoast
	Pointer to this landform's coast.

Detailed Description

Real-world class used to represent the 'drift' category of coastal landform object.

TODO 001 This is a more detailed description of the CRWDrift class.

Author

David Favis-Mortlock

Andres Payo

Date

2025

Copyright

GNU General Public License

Definition at line 27 of file drift.h.

Constructor & Destructor Documentation

CRWDrift()

CRWDrift::CRWDrift	(	CRWCoast *	pCoastIn,
		int const	nCoast,
		int const	nPointOnCoast,
		int const	nLandCat )

Constructor with four parameters and an intialization list.

Definition at line 27 of file drift.cpp.

~CRWDrift()

CRWDrift::~CRWDrift ( void )

override

Destructor.

Definition at line 38 of file drift.cpp.

Member Function Documentation

Display()

void CRWDrift::Display ( void )

overridevirtual

Instantiates the pure virtual function in the abstract parent class, so that CRWDrift is not an abstract class.

Implements CACoastLandform.

Definition at line 43 of file drift.cpp.

Field Documentation

m_dD50

double CRWDrift::m_dD50

private

The drift's d50.

Definition at line 31 of file drift.h.

Referenced by CRWDrift().

---

The documentation for this class was generated from the following files:

• drift.h
• drift.cpp