openswmmvis::street::StreetRegistry Class Reference

#include <streetregistry.h>

Inheritance diagram for openswmmvis::street::StreetRegistry:

Collaboration diagram for openswmmvis::street::StreetRegistry:

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

Public Member Functions
	StreetRegistry (QObject *parent=nullptr)
	~StreetRegistry () override
QVector< StreetProvider * >	providers () const
int	providerCount () const noexcept
StreetProvider *	findByName (const QString &name) const
bool	hasName (const QString &name) const
StreetProvider *	create (const QString &name)
	Create + own a new provider with the given name. Returns the new provider, or nullptr if the name collides.
void	remove (StreetProvider *p)
bool	rename (StreetProvider *p, const QString &newName)
int	loadFromEngine (void *engineHandle)
	Populate from a live SWMM engine handle. Caches engineHandle so the no-arg saveToEngine() overload can flush without re-passing it.
int	saveToEngine (void *engineHandle)
	Push every provider back to the engine via add (if missing) + swmm_street_set_params. Caches engineHandle.
int	saveToEngine ()
	Flush against the engine handle cached by the most recent load / save. No-op if neither has been called.
void *	engineHandle () const noexcept

Constructor & Destructor Documentation

StreetRegistry()

openswmmvis::street::StreetRegistry::StreetRegistry ( QObject *  parent = nullptr )

explicit

~StreetRegistry()

openswmmvis::street::StreetRegistry::~StreetRegistry ( )

overridedefault

Member Function Documentation

create()

StreetProvider * openswmmvis::street::StreetRegistry::create

(

const QString &

name

)

Create + own a new provider with the given name. Returns the new provider, or nullptr if the name collides.

Here is the call graph for this function:

Here is the caller graph for this function:

engineHandle()

void * openswmmvis::street::StreetRegistry::engineHandle ( ) const

inlinenoexcept

Here is the caller graph for this function:

findByName()

StreetProvider * openswmmvis::street::StreetRegistry::findByName

(

const QString &

name

)

const

Here is the caller graph for this function:

hasName()

bool openswmmvis::street::StreetRegistry::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::street::StreetRegistry::loadFromEngine

(

void *

engineHandle

)

Populate from a live SWMM engine handle. Caches engineHandle so the no-arg saveToEngine() overload can flush without re-passing it.

Returns

count added.

Here is the call graph for this function:

providerAboutToBeRemoved

void openswmmvis::street::StreetRegistry::providerAboutToBeRemoved ( openswmmvis::street::StreetProvider *  provider )

signal

Here is the caller graph for this function:

providerAdded

void openswmmvis::street::StreetRegistry::providerAdded ( openswmmvis::street::StreetProvider *  provider )

signal

Here is the caller graph for this function:

providerCount()

int openswmmvis::street::StreetRegistry::providerCount ( ) const

inlinenoexcept

providerParamsChanged

void openswmmvis::street::StreetRegistry::providerParamsChanged ( openswmmvis::street::StreetProvider *  provider )

signal

Here is the caller graph for this function:

providerRenamed

void openswmmvis::street::StreetRegistry::providerRenamed ( openswmmvis::street::StreetProvider *  provider, const QString &  prevName, const QString &  newName  )

signal

Here is the caller graph for this function:

providers()

QVector< StreetProvider * > openswmmvis::street::StreetRegistry::providers ( ) const

inline

remove()

void openswmmvis::street::StreetRegistry::remove

(

StreetProvider *

p

)

Here is the call graph for this function:

rename()

bool openswmmvis::street::StreetRegistry::rename	(	StreetProvider *	p,
		const QString &	newName
	)

Here is the call graph for this function:

saveToEngine() [1/2]

int openswmmvis::street::StreetRegistry::saveToEngine

(

)

Flush against the engine handle cached by the most recent load / save. No-op if neither has been called.

Here is the call graph for this function:

Here is the caller graph for this function:

saveToEngine() [2/2]

int openswmmvis::street::StreetRegistry::saveToEngine

(

void *

engineHandle

)

Push every provider back to the engine via add (if missing) + swmm_street_set_params. Caches 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/street/streetregistry.h
• /home/runner/work/openswmm.gui/openswmm.gui/src/street/streetregistry.cpp