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
SWMMObjectRef Struct Reference

Identifies a single SWMM object. More...

#include <selectionmanager.h>

Collaboration diagram for SWMMObjectRef:

Public Types

enum  ObjectType : int {
  Unknown = 0 ,
  Node = 1 ,
  Link = 2 ,
  Subcatchment = 3 ,
  RainGage = 4 ,
  Pollutant = 5 ,
  LandUse = 6 ,
  Control = 7 ,
  Curve = 8 ,
  TimeSeries = 9 ,
  TimePattern = 10 ,
  LIDControl = 11 ,
  Aquifer = 12 ,
  Snowpack = 13 ,
  Transect = 14 ,
  Hydrograph = 15 ,
  Street = 16 ,
  Inlet = 17 ,
  MeshVertex = 18 ,
  MeshEdge = 19 ,
  MeshCell = 20 ,
  Feature = 21
}
 Coarse object kind. Mirrors the engine's logical groupings; finer subtypes (e.g. junction vs outfall) live elsewhere on the layer / model side because they don't change the identity of the object for selection purposes. More...
 

Public Member Functions

constexpr SWMMObjectRef ()=default
 
 SWMMObjectRef (ObjectType t, QString n)
 
bool isValid () const
 
bool operator== (const SWMMObjectRef &o) const
 
bool operator!= (const SWMMObjectRef &o) const
 

Public Attributes

ObjectType objectType = Unknown
 
QString name
 

Detailed Description

Identifies a single SWMM object.

The pair (objectType, name) is unique within one project: SWMM enforces unique IDs per object class, but two different object classes (a node and a link) may share a name in some legacy .inp files.

Member Enumeration Documentation

◆ ObjectType

Coarse object kind. Mirrors the engine's logical groupings; finer subtypes (e.g. junction vs outfall) live elsewhere on the layer / model side because they don't change the identity of the object for selection purposes.

Enumerator
Unknown 
Node 

Junction / outfall / divider / storage.

Link 

Conduit / pump / orifice / weir / outlet.

Subcatchment 
RainGage 
Pollutant 
LandUse 
Control 
Curve 
TimeSeries 
TimePattern 
LIDControl 
Aquifer 
Snowpack 
Transect 
Hydrograph 
Street 
Inlet 
MeshVertex 
MeshEdge 
MeshCell 

2D mesh triangle/cell (see MeshObjectRef::cell)

Feature 

Constructor & Destructor Documentation

◆ SWMMObjectRef() [1/2]

constexpr SWMMObjectRef::SWMMObjectRef ( )
constexprdefault

◆ SWMMObjectRef() [2/2]

SWMMObjectRef::SWMMObjectRef ( ObjectType  t,
QString  n 
)
inline

Member Function Documentation

◆ isValid()

bool SWMMObjectRef::isValid ( ) const
inline

◆ operator!=()

bool SWMMObjectRef::operator!= ( const SWMMObjectRef o) const
inline

◆ operator==()

bool SWMMObjectRef::operator== ( const SWMMObjectRef o) const
inline

Member Data Documentation

◆ name

QString SWMMObjectRef::name

◆ objectType

ObjectType SWMMObjectRef::objectType = Unknown

The documentation for this struct was generated from the following file: