CRWSedInputEvent Class Reference

Class used to represent a sediment input event. More...

#include <sediment_input_event.h>

Public Member Functions
	CRWSedInputEvent (int const, unsigned long const, double const, double const, double const, double const, double const)
	Constructor with eight parameters and an initialisation list.
	~CRWSedInputEvent (void)
	Destructor.
int	nGetLocationID (void) const
	Returns the location ID.
unsigned long	ulGetEventTimeStep (void) const
	Returns the timestep of the sediment input event.
double	dGetFineSedVol (void) const
	Returns the volume of fine sediment in the sediment input event.
double	dGetSandSedVol (void) const
	Returns the volume of sand sediment in the sediment input event.
double	dGetCoarseSedVol (void) const
	Returns the volume of coarse sediment in the sediment input event.
double	dGetLen (void) const
	Returns the length (in metres?) of the sediment input event.
double	dGetWidth (void) const
	Returns the width (in metres?) of the sediment input event.

Private Attributes
int	m_nLocationID
	The location ID in the shapefile.
unsigned long	m_ulEventTimeStep
	The timing of the sediment input event.
double	m_dFineSedVol
	The volume (m3) of fine sediment in the sediment input event.
double	m_dSandSedVol
	The volume (m3) of sand sediment in the sediment input event.
double	m_dCoarseSedVol
	The volume (m3) of coarse sediment in the sediment input event.
double	m_dLen
	The coast-normal length (m) of the sediment block.
double	m_dWidth
	The along-coast width (m) of the sediment block.

Detailed Description

Class used to represent a sediment input event.

This class represent a sediment input event such as sediment derived from inland (e.g. at the mouth of a gully or rambla), or sediment from an intervention such as beach nourishment

Author

David Favis-Mortlock

Andres Payo

Date

2025

Copyright

GNU General Public License

Definition at line 24 of file sediment_input_event.h.

Constructor & Destructor Documentation

CRWSedInputEvent()

CRWSedInputEvent::CRWSedInputEvent	(	int const	nIDIn,
		unsigned long const	ulTimeStepIn,
		double const	dFineIn,
		double const	dSandIn,
		double const	dCoarseIn,
		double const	dLenIn,
		double const	dWidthIn )

Constructor with eight parameters and an initialisation list.

Definition at line 26 of file sediment_input_event.cpp.

~CRWSedInputEvent()

CRWSedInputEvent::~CRWSedInputEvent

(

void

)

Destructor.

Definition at line 39 of file sediment_input_event.cpp.

Member Function Documentation

dGetCoarseSedVol()

double CRWSedInputEvent::dGetCoarseSedVol

(

void

)

const

Returns the volume of coarse sediment in the sediment input event.

Definition at line 68 of file sediment_input_event.cpp.

dGetFineSedVol()

double CRWSedInputEvent::dGetFineSedVol

(

void

)

const

Returns the volume of fine sediment in the sediment input event.

Definition at line 56 of file sediment_input_event.cpp.

dGetLen()

double CRWSedInputEvent::dGetLen

(

void

)

const

Returns the length (in metres?) of the sediment input event.

Definition at line 74 of file sediment_input_event.cpp.

dGetSandSedVol()

double CRWSedInputEvent::dGetSandSedVol

(

void

)

const

Returns the volume of sand sediment in the sediment input event.

Definition at line 62 of file sediment_input_event.cpp.

dGetWidth()

double CRWSedInputEvent::dGetWidth

(

void

)

const

Returns the width (in metres?) of the sediment input event.

Definition at line 80 of file sediment_input_event.cpp.

nGetLocationID()

int CRWSedInputEvent::nGetLocationID

(

void

)

const

Returns the location ID.

Definition at line 44 of file sediment_input_event.cpp.

ulGetEventTimeStep()

unsigned long CRWSedInputEvent::ulGetEventTimeStep

(

void

)

const

Returns the timestep of the sediment input event.

Definition at line 50 of file sediment_input_event.cpp.

Field Documentation

m_dCoarseSedVol

double CRWSedInputEvent::m_dCoarseSedVol

private

The volume (m3) of coarse sediment in the sediment input event.

Definition at line 40 of file sediment_input_event.h.

Referenced by CRWSedInputEvent(), and dGetCoarseSedVol().

m_dFineSedVol

double CRWSedInputEvent::m_dFineSedVol

private

The volume (m3) of fine sediment in the sediment input event.

Definition at line 34 of file sediment_input_event.h.

Referenced by CRWSedInputEvent(), and dGetFineSedVol().

m_dLen

double CRWSedInputEvent::m_dLen

private

The coast-normal length (m) of the sediment block.

Definition at line 43 of file sediment_input_event.h.

Referenced by CRWSedInputEvent(), and dGetLen().

m_dSandSedVol

double CRWSedInputEvent::m_dSandSedVol

private

The volume (m3) of sand sediment in the sediment input event.

Definition at line 37 of file sediment_input_event.h.

Referenced by CRWSedInputEvent(), and dGetSandSedVol().

m_dWidth

double CRWSedInputEvent::m_dWidth

private

The along-coast width (m) of the sediment block.

Definition at line 46 of file sediment_input_event.h.

Referenced by CRWSedInputEvent(), and dGetWidth().

m_nLocationID

int CRWSedInputEvent::m_nLocationID

private

The location ID in the shapefile.

Definition at line 28 of file sediment_input_event.h.

Referenced by CRWSedInputEvent(), and nGetLocationID().

m_ulEventTimeStep

unsigned long CRWSedInputEvent::m_ulEventTimeStep

private

The timing of the sediment input event.

Definition at line 31 of file sediment_input_event.h.

Referenced by CRWSedInputEvent(), and ulGetEventTimeStep().

---

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

• sediment_input_event.h
• sediment_input_event.cpp