SWMMPollutantPropertyAdapter Class Reference

#include <swmmpollutantpropertyadapter.h>

Inheritance diagram for SWMMPollutantPropertyAdapter:

Collaboration diagram for SWMMPollutantPropertyAdapter:

Public Types
enum	Units {   MgPerL = 0 ,   UgPerL = 1 ,   CountPerL = 2 }

Public Slots
void	setRainConc (double v)
void	setGwConc (double v)
void	setInitConc (double v)
void	setRdiiConc (double v)
void	setKDecay (double v)
void	setMwt (double v)
void	setSnowOnly (bool v)
void	setCoPollutant (const QString &poll)
void	setCoPollutantRef (const DataObjectRef &ref)
void	setCoPollutantFrac (double v)
Public Slots inherited from SWMMDataObjectPropertyAdapter
void	setName (const QString &newName)
void	updateStoredName (const QString &newName)
void	refresh ()

Public Member Functions
Units	units () const
double	rainConc () const
double	gwConc () const
double	initConc () const
double	rdiiConc () const
double	kDecay () const
double	mwt () const
bool	snowOnly () const
QString	coPollutant () const
DataObjectRef	coPollutantRef () const
double	coPollutantFrac () const
Q_INVOKABLE QString	displayLabelFor (const QString &property) const
	SWMMDataObjectPropertyAdapter (SWMM_Engine engine, QString name, QObject *parent=nullptr)
Public Member Functions inherited from SWMMDataObjectPropertyAdapter
	SWMMDataObjectPropertyAdapter (SWMM_Engine engine, QString name, QObject *parent=nullptr)
	~SWMMDataObjectPropertyAdapter () override=default
QString	name () const
SWMM_Engine	engine () const
void	setModelLayer (SWMMModelLayer *layer)
SWMMModelLayer *	modelLayer () const

Properties
SWMMPollutantPropertyAdapter::Units	units
double	rainConc
double	gwConc
double	initConc
double	rdiiConc
double	kDecay
double	mwt
bool	snowOnly
DataObjectRef	coPollutant
double	coPollutantFrac
Properties inherited from SWMMDataObjectPropertyAdapter
QString	name

Additional Inherited Members
Signals inherited from SWMMDataObjectPropertyAdapter
void	changed ()
void	renameRequested (const QString &oldName, const QString &newName)
void	displayLabelsChanged ()
Protected Attributes inherited from SWMMDataObjectPropertyAdapter
SWMM_Engine	m_engine
QString	m_name
SWMMModelLayer *	m_layer = nullptr
	Bound via setModelLayer.

Member Enumeration Documentation

Units

enum SWMMPollutantPropertyAdapter::Units

Concentration units. Q_ENUM so the Property Browser shows the name rather than a raw integer. Mixed-case to dodge macro collisions.

Enumerator
MgPerL
UgPerL
CountPerL

Member Function Documentation

coPollutant()

QString SWMMPollutantPropertyAdapter::coPollutant

(

)

const

Name of the linked co-pollutant, or empty if none.

coPollutantFrac()

double SWMMPollutantPropertyAdapter::coPollutantFrac

(

)

const

coPollutantRef()

DataObjectRef SWMMPollutantPropertyAdapter::coPollutantRef

(

)

const

Slice BM.0-Browse-Edit — DataObjectRef wrapper of coPollutant().

displayLabelFor()

QString SWMMPollutantPropertyAdapter::displayLabelFor

(

const QString &

property

)

const

gwConc()

double SWMMPollutantPropertyAdapter::gwConc

(

)

const

initConc()

double SWMMPollutantPropertyAdapter::initConc

(

)

const

kDecay()

double SWMMPollutantPropertyAdapter::kDecay

(

)

const

mwt()

double SWMMPollutantPropertyAdapter::mwt

(

)

const

rainConc()

double SWMMPollutantPropertyAdapter::rainConc

(

)

const

rdiiConc()

double SWMMPollutantPropertyAdapter::rdiiConc

(

)

const

setCoPollutant

void SWMMPollutantPropertyAdapter::setCoPollutant ( const QString &  poll )

slot

Here is the call graph for this function:

Here is the caller graph for this function:

setCoPollutantFrac

void SWMMPollutantPropertyAdapter::setCoPollutantFrac ( double  v )

slot

Here is the call graph for this function:

setCoPollutantRef

void SWMMPollutantPropertyAdapter::setCoPollutantRef ( const DataObjectRef &  ref )

slot

Slice BM.0-Browse-Edit — DataObjectRef-form setter for the co-pollutant. Thin wrapper around setCoPollutant that extracts the name from the ref.

Here is the call graph for this function:

setGwConc

void SWMMPollutantPropertyAdapter::setGwConc ( double  v )

slot

setInitConc

void SWMMPollutantPropertyAdapter::setInitConc ( double  v )

slot

setKDecay

void SWMMPollutantPropertyAdapter::setKDecay ( double  v )

slot

setMwt

void SWMMPollutantPropertyAdapter::setMwt ( double  v )

slot

setRainConc

void SWMMPollutantPropertyAdapter::setRainConc ( double  v )

slot

setRdiiConc

void SWMMPollutantPropertyAdapter::setRdiiConc ( double  v )

slot

setSnowOnly

double double double void SWMMPollutantPropertyAdapter::setSnowOnly ( bool  v )

slot

Here is the call graph for this function:

snowOnly()

bool SWMMPollutantPropertyAdapter::snowOnly

(

)

const

SWMMDataObjectPropertyAdapter()

SWMMDataObjectPropertyAdapter::SWMMDataObjectPropertyAdapter	(	SWMM_Engine	engine,
		QString	name,
		QObject *	parent = nullptr
	)

units()

SWMMPollutantPropertyAdapter::Units SWMMPollutantPropertyAdapter::units

(

)

const

Property Documentation

coPollutant

DataObjectRef SWMMPollutantPropertyAdapter::coPollutant

readwrite

coPollutantFrac

double SWMMPollutantPropertyAdapter::coPollutantFrac

readwrite

gwConc

double SWMMPollutantPropertyAdapter::gwConc

readwrite

initConc

double SWMMPollutantPropertyAdapter::initConc

readwrite

kDecay

double SWMMPollutantPropertyAdapter::kDecay

readwrite

mwt

double SWMMPollutantPropertyAdapter::mwt

readwrite

rainConc

double SWMMPollutantPropertyAdapter::rainConc

readwrite

rdiiConc

double SWMMPollutantPropertyAdapter::rdiiConc

readwrite

snowOnly

bool SWMMPollutantPropertyAdapter::snowOnly

readwrite

units

SWMMPollutantPropertyAdapter::Units SWMMPollutantPropertyAdapter::units

read

---

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

• /home/runner/work/openswmm.gui/openswmm.gui/include/ui/properties/swmmpollutantpropertyadapter.h
• /home/runner/work/openswmm.gui/openswmm.gui/src/ui/properties/swmmpollutantpropertyadapter.cpp