openswmmvis::transect::TransectRegistry Class Reference

#include <transectregistry.h>

Inheritance diagram for openswmmvis::transect::TransectRegistry:

Collaboration diagram for openswmmvis::transect::TransectRegistry:

Signals
void	providerAdded (openswmmvis::transect::TransectProvider *provider)
void	providerAboutToBeRemoved (openswmmvis::transect::TransectProvider *provider)
void	providerRenamed (openswmmvis::transect::TransectProvider *provider, const QString &prevName, const QString &newName)
void	providerPointsChanged (openswmmvis::transect::TransectProvider *provider)
void	providerMetadataChanged (openswmmvis::transect::TransectProvider *provider)

Public Member Functions
	TransectRegistry (QObject *parent=nullptr)
	~TransectRegistry () override
QVector< TransectProvider * >	providers () const
int	providerCount () const noexcept
TransectProvider *	findByName (const QString &name) const
bool	hasName (const QString &name) const
TransectProvider *	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 (TransectProvider *p)
bool	rename (TransectProvider *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 clear+re-add of the stations + setters for the scalar fields. Caches engineHandle.
int	saveToEngine ()
	Flush against the engine handle cached by the most recent loadFromEngine / saveToEngine(handle) call. No-op if neither has been called yet. Mirrors TimeseriesRegistry::saveToEngine().
void *	engineHandle () const noexcept
	Engine handle cached from the most recent load / save, or nullptr if none.

Constructor & Destructor Documentation

TransectRegistry()

openswmmvis::transect::TransectRegistry::TransectRegistry ( QObject *  parent = nullptr )

explicit

~TransectRegistry()

openswmmvis::transect::TransectRegistry::~TransectRegistry ( )

overridedefault

Member Function Documentation

create()

TransectProvider * openswmmvis::transect::TransectRegistry::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::transect::TransectRegistry::engineHandle ( ) const

inlinenoexcept

Engine handle cached from the most recent load / save, or nullptr if none.

Here is the caller graph for this function:

findByName()

TransectProvider * openswmmvis::transect::TransectRegistry::findByName

(

const QString &

name

)

const

Here is the caller graph for this function:

hasName()

bool openswmmvis::transect::TransectRegistry::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::transect::TransectRegistry::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::transect::TransectRegistry::providerAboutToBeRemoved ( openswmmvis::transect::TransectProvider *  provider )

signal

Here is the caller graph for this function:

providerAdded

void openswmmvis::transect::TransectRegistry::providerAdded ( openswmmvis::transect::TransectProvider *  provider )

signal

Here is the caller graph for this function:

providerCount()

int openswmmvis::transect::TransectRegistry::providerCount ( ) const

inlinenoexcept

providerMetadataChanged

void openswmmvis::transect::TransectRegistry::providerMetadataChanged ( openswmmvis::transect::TransectProvider *  provider )

signal

Here is the caller graph for this function:

providerPointsChanged

void openswmmvis::transect::TransectRegistry::providerPointsChanged ( openswmmvis::transect::TransectProvider *  provider )

signal

Here is the caller graph for this function:

providerRenamed

void openswmmvis::transect::TransectRegistry::providerRenamed ( openswmmvis::transect::TransectProvider *  provider, const QString &  prevName, const QString &  newName  )

signal

Here is the caller graph for this function:

providers()

QVector< TransectProvider * > openswmmvis::transect::TransectRegistry::providers ( ) const

inline

remove()

void openswmmvis::transect::TransectRegistry::remove

(

TransectProvider *

p

)

Here is the call graph for this function:

Here is the caller graph for this function:

rename()

bool openswmmvis::transect::TransectRegistry::rename	(	TransectProvider *	p,
		const QString &	newName
	)

Here is the call graph for this function:

Here is the caller graph for this function:

saveToEngine() [1/2]

int openswmmvis::transect::TransectRegistry::saveToEngine

(

)

Flush against the engine handle cached by the most recent loadFromEngine / saveToEngine(handle) call. No-op if neither has been called yet. Mirrors TimeseriesRegistry::saveToEngine().

Here is the call graph for this function:

Here is the caller graph for this function:

saveToEngine() [2/2]

int openswmmvis::transect::TransectRegistry::saveToEngine

(

void *

engineHandle

)

Push every provider back to the engine via clear+re-add of the stations + setters for the scalar fields. 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/transect/transectregistry.h
• /home/runner/work/openswmm.gui/openswmm.gui/src/transect/transectregistry.cpp