SWMMVis  6.0.0-alpha.4
Qt6/C++ GIS-based graphical user interface for the SWMMVis engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
openswmmvis::inlet::InletRegistry Class Reference

#include <inletregistry.h>

Inheritance diagram for openswmmvis::inlet::InletRegistry:
Collaboration diagram for openswmmvis::inlet::InletRegistry:

Signals

void providerAdded (openswmmvis::inlet::InletProvider *provider)
 
void providerAboutToBeRemoved (openswmmvis::inlet::InletProvider *provider)
 
void providerRenamed (openswmmvis::inlet::InletProvider *provider, const QString &prevName, const QString &newName)
 
void providerParamsChanged (openswmmvis::inlet::InletProvider *provider)
 

Public Member Functions

 InletRegistry (QObject *parent=nullptr)
 
 ~InletRegistry () override
 
QVector< InletProvider * > providers () const
 
int providerCount () const noexcept
 
InletProviderfindByName (const QString &name) const
 
bool hasName (const QString &name) const
 
InletProvidercreate (const QString &name)
 
void remove (InletProvider *p)
 
bool rename (InletProvider *p, const QString &newName)
 
QString impactSummary (InletProvider *p) const
 Human-readable summary of what references p, from swmm_inlet_analyze_impact. Empty when nothing references it (or when the registry has no engine bound).
 
int loadFromEngine (void *engineHandle)
 
int saveToEngine (void *engineHandle)
 
int saveToEngine ()
 
void * engineHandle () const noexcept
 

Constructor & Destructor Documentation

◆ InletRegistry()

openswmmvis::inlet::InletRegistry::InletRegistry ( QObject *  parent = nullptr)
explicit

◆ ~InletRegistry()

openswmmvis::inlet::InletRegistry::~InletRegistry ( )
overridedefault

Member Function Documentation

◆ create()

InletProvider * openswmmvis::inlet::InletRegistry::create ( const QString &  name)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ engineHandle()

void * openswmmvis::inlet::InletRegistry::engineHandle ( ) const
inlinenoexcept
Here is the caller graph for this function:

◆ findByName()

InletProvider * openswmmvis::inlet::InletRegistry::findByName ( const QString &  name) const
Here is the caller graph for this function:

◆ hasName()

bool openswmmvis::inlet::InletRegistry::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::inlet::InletRegistry::impactSummary ( InletProvider p) const

Human-readable summary of what references p, from swmm_inlet_analyze_impact. Empty when nothing references it (or when the registry has no engine bound).

◆ loadFromEngine()

int openswmmvis::inlet::InletRegistry::loadFromEngine ( void *  engineHandle)
Here is the call graph for this function:

◆ providerAboutToBeRemoved

void openswmmvis::inlet::InletRegistry::providerAboutToBeRemoved ( openswmmvis::inlet::InletProvider provider)
signal
Here is the caller graph for this function:

◆ providerAdded

void openswmmvis::inlet::InletRegistry::providerAdded ( openswmmvis::inlet::InletProvider provider)
signal
Here is the caller graph for this function:

◆ providerCount()

int openswmmvis::inlet::InletRegistry::providerCount ( ) const
inlinenoexcept

◆ providerParamsChanged

void openswmmvis::inlet::InletRegistry::providerParamsChanged ( openswmmvis::inlet::InletProvider provider)
signal
Here is the caller graph for this function:

◆ providerRenamed

void openswmmvis::inlet::InletRegistry::providerRenamed ( openswmmvis::inlet::InletProvider provider,
const QString &  prevName,
const QString &  newName 
)
signal
Here is the caller graph for this function:

◆ providers()

QVector< InletProvider * > openswmmvis::inlet::InletRegistry::providers ( ) const
inline
Here is the caller graph for this function:

◆ remove()

void openswmmvis::inlet::InletRegistry::remove ( InletProvider p)
Here is the call graph for this function:

◆ rename()

bool openswmmvis::inlet::InletRegistry::rename ( InletProvider p,
const QString &  newName 
)
Here is the call graph for this function:

◆ saveToEngine() [1/2]

int openswmmvis::inlet::InletRegistry::saveToEngine ( )
Here is the call graph for this function:
Here is the caller graph for this function:

◆ saveToEngine() [2/2]

int openswmmvis::inlet::InletRegistry::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: