openswmmvis::aquifer::AquiferRegistry Class Reference

#include <aquiferregistry.h>

Inheritance diagram for openswmmvis::aquifer::AquiferRegistry:

Collaboration diagram for openswmmvis::aquifer::AquiferRegistry:

Signals
void	providerAdded (openswmmvis::aquifer::AquiferProvider *provider)
void	providerAboutToBeRemoved (openswmmvis::aquifer::AquiferProvider *provider)
void	providerRenamed (openswmmvis::aquifer::AquiferProvider *provider, const QString &prevName, const QString &newName)
void	providerParamsChanged (openswmmvis::aquifer::AquiferProvider *provider)

Public Member Functions
	AquiferRegistry (QObject *parent=nullptr)
	~AquiferRegistry () override
QVector< AquiferProvider * >	providers () const
int	providerCount () const noexcept
AquiferProvider *	findByName (const QString &name) const
bool	hasName (const QString &name) const
AquiferProvider *	create (const QString &name)
void	remove (AquiferProvider *p)
bool	rename (AquiferProvider *p, const QString &newName)
QString	impactSummary (AquiferProvider *p) const
int	loadFromEngine (void *engineHandle)
int	saveToEngine (void *engineHandle)
int	saveToEngine ()
void *	engineHandle () const noexcept

Constructor & Destructor Documentation

AquiferRegistry()

openswmmvis::aquifer::AquiferRegistry::AquiferRegistry ( QObject *  parent = nullptr )

explicit

~AquiferRegistry()

openswmmvis::aquifer::AquiferRegistry::~AquiferRegistry ( )

overridedefault

Member Function Documentation

create()

AquiferProvider * openswmmvis::aquifer::AquiferRegistry::create

(

const QString &

name

)

Here is the call graph for this function:

Here is the caller graph for this function:

engineHandle()

void * openswmmvis::aquifer::AquiferRegistry::engineHandle ( ) const

inlinenoexcept

Here is the caller graph for this function:

findByName()

AquiferProvider * openswmmvis::aquifer::AquiferRegistry::findByName

(

const QString &

name

)

const

Here is the caller graph for this function:

hasName()

bool openswmmvis::aquifer::AquiferRegistry::hasName ( const QString &  name ) const

inline

Here is the call graph for this function:

Here is the caller graph for this function:

impactSummary()

QString openswmmvis::aquifer::AquiferRegistry::impactSummary

(

AquiferProvider *

p

)

const

Human-readable summary of what deleting p would affect, from swmm_aquifer_analyze_impact (e.g. "3 subcatchment(s) reference this aquifer and will lose it."). Empty when nothing references it or there is no engine.

loadFromEngine()

int openswmmvis::aquifer::AquiferRegistry::loadFromEngine

(

void *

engineHandle

)

Here is the call graph for this function:

providerAboutToBeRemoved

void openswmmvis::aquifer::AquiferRegistry::providerAboutToBeRemoved ( openswmmvis::aquifer::AquiferProvider *  provider )

signal

Here is the caller graph for this function:

providerAdded

void openswmmvis::aquifer::AquiferRegistry::providerAdded ( openswmmvis::aquifer::AquiferProvider *  provider )

signal

Here is the caller graph for this function:

providerCount()

int openswmmvis::aquifer::AquiferRegistry::providerCount ( ) const

inlinenoexcept

providerParamsChanged

void openswmmvis::aquifer::AquiferRegistry::providerParamsChanged ( openswmmvis::aquifer::AquiferProvider *  provider )

signal

Here is the caller graph for this function:

providerRenamed

void openswmmvis::aquifer::AquiferRegistry::providerRenamed ( openswmmvis::aquifer::AquiferProvider *  provider, const QString &  prevName, const QString &  newName  )

signal

Here is the caller graph for this function:

providers()

QVector< AquiferProvider * > openswmmvis::aquifer::AquiferRegistry::providers ( ) const

inline

remove()

void openswmmvis::aquifer::AquiferRegistry::remove

(

AquiferProvider *

p

)

Here is the call graph for this function:

rename()

bool openswmmvis::aquifer::AquiferRegistry::rename	(	AquiferProvider *	p,
		const QString &	newName
	)

Here is the call graph for this function:

saveToEngine() [1/2]

int openswmmvis::aquifer::AquiferRegistry::saveToEngine

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

saveToEngine() [2/2]

int openswmmvis::aquifer::AquiferRegistry::saveToEngine

(

void *

engineHandle

)

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• /home/runner/work/openswmm.gui/openswmm.gui/include/aquifer/aquiferregistry.h
• /home/runner/work/openswmm.gui/openswmm.gui/src/aquifer/aquiferregistry.cpp