openswmmvis::pollutant::PollutantRegistry Class Reference

#include <pollutantregistry.h>

Inheritance diagram for openswmmvis::pollutant::PollutantRegistry:

Collaboration diagram for openswmmvis::pollutant::PollutantRegistry:

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

Public Member Functions
	PollutantRegistry (QObject *parent=nullptr)
	~PollutantRegistry () override
QVector< PollutantProvider * >	providers () const
int	providerCount () const noexcept
PollutantProvider *	findByName (const QString &name) const
bool	hasName (const QString &name) const
PollutantProvider *	create (const QString &name)
	Create + own a new provider. Returns nullptr on name collision.
void	remove (PollutantProvider *p)
bool	rename (PollutantProvider *p, const QString &newName)
int	loadFromEngine (void *engineHandle)
	Populate from a live SWMM engine handle.
int	saveToEngine (void *engineHandle)
	Push every provider back to the engine (add if missing, then set scalar params; co-pollutant resolved in a second pass).
int	saveToEngine ()
	Flush against the cached engine handle. No-op if never set.
void *	engineHandle () const noexcept

Constructor & Destructor Documentation

PollutantRegistry()

openswmmvis::pollutant::PollutantRegistry::PollutantRegistry ( QObject *  parent = nullptr )

explicit

~PollutantRegistry()

openswmmvis::pollutant::PollutantRegistry::~PollutantRegistry ( )

overridedefault

Member Function Documentation

create()

PollutantProvider * openswmmvis::pollutant::PollutantRegistry::create

(

const QString &

name

)

Create + own a new provider. Returns nullptr on name collision.

Here is the call graph for this function:

Here is the caller graph for this function:

engineHandle()

void * openswmmvis::pollutant::PollutantRegistry::engineHandle ( ) const

inlinenoexcept

Here is the caller graph for this function:

findByName()

PollutantProvider * openswmmvis::pollutant::PollutantRegistry::findByName

(

const QString &

name

)

const

Here is the caller graph for this function:

hasName()

bool openswmmvis::pollutant::PollutantRegistry::hasName ( const QString &  name ) const

inline

Here is the call graph for this function:

Here is the caller graph for this function:

loadFromEngine()

int openswmmvis::pollutant::PollutantRegistry::loadFromEngine

(

void *

engineHandle

)

Populate from a live SWMM engine handle.

Returns

count added.

Here is the call graph for this function:

providerAboutToBeRemoved

void openswmmvis::pollutant::PollutantRegistry::providerAboutToBeRemoved ( openswmmvis::pollutant::PollutantProvider *  provider )

signal

Here is the caller graph for this function:

providerAdded

void openswmmvis::pollutant::PollutantRegistry::providerAdded ( openswmmvis::pollutant::PollutantProvider *  provider )

signal

Here is the caller graph for this function:

providerCount()

int openswmmvis::pollutant::PollutantRegistry::providerCount ( ) const

inlinenoexcept

providerParamsChanged

void openswmmvis::pollutant::PollutantRegistry::providerParamsChanged ( openswmmvis::pollutant::PollutantProvider *  provider )

signal

Here is the caller graph for this function:

providerRenamed

void openswmmvis::pollutant::PollutantRegistry::providerRenamed ( openswmmvis::pollutant::PollutantProvider *  provider, const QString &  prevName, const QString &  newName  )

signal

Here is the caller graph for this function:

providers()

QVector< PollutantProvider * > openswmmvis::pollutant::PollutantRegistry::providers ( ) const

inline

remove()

void openswmmvis::pollutant::PollutantRegistry::remove

(

PollutantProvider *

p

)

Here is the call graph for this function:

rename()

bool openswmmvis::pollutant::PollutantRegistry::rename	(	PollutantProvider *	p,
		const QString &	newName
	)

Here is the call graph for this function:

saveToEngine() [1/2]

int openswmmvis::pollutant::PollutantRegistry::saveToEngine

(

)

Flush against the cached engine handle. No-op if never set.

Here is the call graph for this function:

Here is the caller graph for this function:

saveToEngine() [2/2]

int openswmmvis::pollutant::PollutantRegistry::saveToEngine

(

void *

engineHandle

)

Push every provider back to the engine (add if missing, then set scalar params; co-pollutant resolved in a second pass).

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/pollutant/pollutantregistry.h
• /home/runner/work/openswmm.gui/openswmm.gui/src/pollutant/pollutantregistry.cpp