ProfileBuilder::LinkStatic Struct Reference

Time-invariant per-link properties. Only links present on the chosen path are populated. Indices in PathStatic::links are 0..N-1 where N == PathStatic::nodes.size() - 1, and link[i] joins node[i] → node[i+1] in path-traversal order (which may differ from the underlying model link's intrinsic from/to direction when the router operated in undirected mode). More...

#include <profilebuilder.h>

Collaboration diagram for ProfileBuilder::LinkStatic:

Public Attributes
QString	name
double	length = 0.0
double	offset1 = 0.0
double	offset2 = 0.0
double	maxDepth = 0.0
double	crestHeight = 0.0
bool	openTop = false
bool	isStreet = false
LinkKind	kind = LinkKind::Conduit
bool	reversed = false

Detailed Description

Time-invariant per-link properties. Only links present on the chosen path are populated. Indices in PathStatic::links are 0..N-1 where N == PathStatic::nodes.size() - 1, and link[i] joins node[i] → node[i+1] in path-traversal order (which may differ from the underlying model link's intrinsic from/to direction when the router operated in undirected mode).

Member Data Documentation

crestHeight

double ProfileBuilder::LinkStatic::crestHeight = 0.0

Weir / outlet crest height above the inlet (path-upstream) node invert. Read via swmm_link_get_crest_height. Zero for conduits / pumps / orifices.

isStreet

bool ProfileBuilder::LinkStatic::isStreet = false

STREET cross-section: the invert is a road gutter line and is drawn with the pavement brush. Carried as a plain flag so the renderer stays free of engine shape codes.

kind

LinkKind ProfileBuilder::LinkStatic::kind = LinkKind::Conduit

length

double ProfileBuilder::LinkStatic::length = 0.0

maxDepth

double ProfileBuilder::LinkStatic::maxDepth = 0.0

Cross-section max depth (crown offset).

name

QString ProfileBuilder::LinkStatic::name

offset1

double ProfileBuilder::LinkStatic::offset1 = 0.0

Invert offset at path-upstream end. Per SWMM convention, kept at 0 for weirs / outlets — use crestHeight for their sill elevation.

offset2

double ProfileBuilder::LinkStatic::offset2 = 0.0

Invert offset at path-downstream end.

openTop

bool ProfileBuilder::LinkStatic::openTop = false

Draw with no soffit line (open channel, or a street). Presentation only — see linkFullDepth() in xsectsampler.h.

reversed

bool ProfileBuilder::LinkStatic::reversed = false

True when traversal direction is the reverse of the underlying model link; lets the velocity-sign convention map correctly in EGL computation.

---

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

• /home/runner/work/openswmm.gui/openswmm.gui/include/plot/profilebuilder.h