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, int const) | |
| Constructor with four 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 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. | |
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 'intervention' category of coastal landform objects.
TODO 001 This is a more detailed description of the CRWIntervention class.
- Date
- 2025
- Copyright
- GNU General Public License
Definition at line 27 of file intervention.h.
Constructor & Destructor Documentation
◆ CRWIntervention()
| CRWIntervention::CRWIntervention | ( | CRWCoast * | pCoastIn, |
| int const | nCoast, | ||
| int const | nPointOnCoast, | ||
| int const | nLandCategory ) |
Constructor with four parameters.
Definition at line 30 of file intervention.cpp.
◆ ~CRWIntervention()
|
override |
Destructor.
Definition at line 40 of file intervention.cpp.
Member Function Documentation
◆ Display()
|
overridevirtual |
Instantiates the pure virtual function in the abstract parent class, so that CRWIntervention is not an abstract class.
Implements CACoastLandform.
Definition at line 45 of file intervention.cpp.
The documentation for this class was generated from the following files:
