openswmmvis::trace Namespace Reference

Classes
class	AnalysisStore
struct	Channel
struct	Dataset
struct	JobReply
struct	Link
struct	Node
struct	Result
struct	Snapshot
class	TraceAnalysisDialog
class	TraceAnalysisLayer
class	TraceController
struct	TraceLabels
class	TraceStyle
class	TraceSublayer

Functions
QPainterPath	taperedPath (const QVector< QPointF > &input, double startWidth, double endWidth)
	Build a filled pixel-space ribbon with segment quads and round join disks.
QString	fieldLabel (const QString &f, bool node=false)
QString	statusText (int flags)
	Format trace availability/approximation flags for display and persisted diagnostics.
QJsonObject	infoJson (const SWMM_TraceInfo &i)
	Encode trace source/algorithm coverage metadata.
SWMM_TraceInfo	infoFromJson (const QJsonObject &j)
	Decode trace coverage metadata without schema validation.
QJsonObject	optionsJson (const SWMM_TraceOptions &o)
	Encode trace numerical thresholds for package provenance.
SWMM_TraceOptions	optionsFromJson (const QJsonObject &j)
	Overlay saved numerical options onto native defaults.
QJsonObject	summaryJson (const SWMM_TraceSummary &s)
	Encode terminal fractions and SI trace-budget diagnostics.
SWMM_TraceSummary	summaryFromJson (const QJsonObject &j)
	Decode persisted trace-budget diagnostics.
SWMM_Trace	createHandle (const Snapshot &s, const SWMM_TraceOptions &o, QString *error)
	Create native trace topology/options on the calling thread.

Function Documentation

createHandle()

SWMM_Trace openswmmvis::trace::createHandle	(	const Snapshot &	s,
		const SWMM_TraceOptions &	o,
		QString *	error
	)

Create native trace topology/options on the calling thread.

Parameters

[in]	s	Valid owning topology snapshot; coordinates are not passed to the hydraulic estimator.
[in]	o	Native trace solver options.
[out]	error	Optional topology/native-create diagnostic, unchanged on success.

Returns

Owned native trace handle requiring swmm_trace_close() on the owning thread, or null on failure. Node/link ID bytes are copied by the native creation API.

Here is the call graph for this function:

Here is the caller graph for this function:

fieldLabel()

QString openswmmvis::trace::fieldLabel	(	const QString &	f,
		bool	node = false
	)

Parameters

[in]	f	Exact lowercase field key ratio/flow/gross/time/local/coverage/volume, other strings treated as uniform.
[in]	node	Whether node-specific flow/gross wording is needed.

Returns

Translated field heading including SI flow/volume or minute time units; ratio/coverage are dimensionless.

Here is the caller graph for this function:

infoFromJson()

SWMM_TraceInfo openswmmvis::trace::infoFromJson

(

const QJsonObject &

j

)

Decode trace coverage metadata without schema validation.

Parameters

[in]

j

Serialized native info fields.

Returns

Value struct using Qt zero defaults for missing fields and zero reserved field.

Here is the call graph for this function:

Here is the caller graph for this function:

infoJson()

QJsonObject openswmmvis::trace::infoJson

(

const SWMM_TraceInfo &

i

)

Encode trace source/algorithm coverage metadata.

Parameters

[in]

i

Native trace info with SWMM report dates and duration in seconds.

Returns

Owning JSON fields, preserving native SI/source-unit provenance.

Here is the call graph for this function:

Here is the caller graph for this function:

optionsFromJson()

SWMM_TraceOptions openswmmvis::trace::optionsFromJson

(

const QJsonObject &

j

)

Overlay saved numerical options onto native defaults.

Parameters

[in]

j

Optional threshold/iteration fields; absent or nonnumeric values retain defaults.

Returns

Options without physical/algorithm-range validation; native create validates applicability.

Here is the call graph for this function:

Here is the caller graph for this function:

optionsJson()

QJsonObject openswmmvis::trace::optionsJson

(

const SWMM_TraceOptions &

o

)

Encode trace numerical thresholds for package provenance.

Parameters

[in]

o

Native options: flow epsilon m3/s, velocity epsilon m/s, dimensionless dominance/tolerance, and iteration count.

Returns

Owning JSON object without conversion.

Here is the call graph for this function:

Here is the caller graph for this function:

statusText()

QString openswmmvis::trace::statusText

(

int

flags

)

Format trace availability/approximation flags for display and persisted diagnostics.

Parameters

[in]

flags

SWMM_TRACE_* bitmask.

Returns

Semicolon-separated recognized conditions, or OK when none are recognized; Unknown time suppresses the Partial time label.

Here is the call graph for this function:

Here is the caller graph for this function:

summaryFromJson()

SWMM_TraceSummary openswmmvis::trace::summaryFromJson

(

const QJsonObject &

j

)

Decode persisted trace-budget diagnostics.

Parameters

[in]

j

Saved summary object.

Returns

Value summary with zero defaults for missing fields, bounded terminal-array copy, and NaN for absent/nonnumeric partial residual.

Here is the call graph for this function:

Here is the caller graph for this function:

summaryJson()

QJsonObject openswmmvis::trace::summaryJson

(

const SWMM_TraceSummary &

s

)

Encode terminal fractions and SI trace-budget diagnostics.

Parameters

[in]

s

Native summary with cubic-metre budgets, dimensionless accounting/solver residuals, and reach counts.

Returns

Owning JSON object; nonfinite partial-balance residual is null.

Here is the call graph for this function:

Here is the caller graph for this function:

taperedPath()

QPainterPath openswmmvis::trace::taperedPath	(	const QVector< QPointF > &	input,
		double	startWidth,
		double	endWidth
	)

Build a filled pixel-space ribbon with segment quads and round join disks.

Parameters

[in]	input	Logical-pixel polyline; nonfinite/consecutive near-duplicate points (distance<=1e-8) are discarded.
[in]	startWidth	Finite nonnegative total width at the first retained point in the same pixel unit.
[in]	endWidth	Finite nonnegative total width at the last retained point, linearly interpolated by cumulative arc length.

Returns

Owned WindingFill path, empty with fewer than two usable points. No arrowhead or precise endpoint cap is added; caller supplies widths and paints/tests it.

Here is the caller graph for this function: