CoastalME (Coastal Modelling Environment)
Simulates the long-term behaviour of complex coastlines
Loading...
Searching...
No Matches
CRWIntervention Class Reference

Real-world class used to represent the 'intervention' category of coastal landform objects. More...

#include <intervention.h>

Inherits CACoastLandform.

Public Member Functions

 CRWIntervention (CRWCoast *, int const, int const)
 Constructor with three parameters.
 
 ~CRWIntervention (void) override
 Destructor.
 
void Display (void) override
 Instantiates the pure virtual function in the abstract parent class, so that CRWIntervention is not an abstract class.
 
- Public Member Functions inherited from CACoastLandform
 CACoastLandform (void)
 Constructor with initialization 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.
 
CGeom2DIPointpPtiGetCellMarkedAsLF (void) const
 Get the grid coordinates of the cell on which this coast landform sits.
 
void IncTotAccumWaveEnergy (double const)
 Increment total accumulated wave energy.
 
double dGetTotAccumWaveEnergy (void) const
 Get total accumulated wave energy.
 

Additional Inherited Members

- Protected Attributes inherited from CACoastLandform
int m_nCoast
 The coast number on which this coast landform sits.
 
int m_nPointOnCoast
 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.
 
CRWCoastpCoast
 Pointer to this landform's coast.
 

Detailed Description

Real-world class used to represent the 'intervention' category of coastal landform objects.

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

Author
David Favis-Mortlock
Andres Payo
Date
2025

Definition at line 32 of file intervention.h.

Constructor & Destructor Documentation

◆ CRWIntervention()

CRWIntervention::CRWIntervention ( CRWCoast * pCoastIn,
int const nCoast,
int const nPointOnCoast )

Constructor with three parameters.

Definition at line 36 of file intervention.cpp.

◆ ~CRWIntervention()

CRWIntervention::~CRWIntervention ( void )
override

Destructor.

Definition at line 46 of file intervention.cpp.

Member Function Documentation

◆ Display()

void CRWIntervention::Display ( void )
overridevirtual

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

Implements CACoastLandform.

Definition at line 51 of file intervention.cpp.


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