ProfileAttributeSampler Namespace Reference

Classes
struct	AttributeProfile
	One attribute × one source, sampled along the whole path for the whole simulation. More...

Functions
bool	isNodeAttribute (openswmmvis::plot::PlotAttribute attr)
	True for the six Node* attributes, false for everything else. Inline (header-only) so UI code and tests can classify attributes without linking the sampler's engine/results-layer dependency chain.
bool	isTrackableAttribute (openswmmvis::plot::PlotAttribute attr)
	True when attr is one of the 11 attributes a track can show.
AttributeProfile	fetch (SWMMResultsLayer *resultsLayer, const ProfileBuilder::PathStatic &path, openswmmvis::plot::PlotAttribute attr)
	Fetches the full-simulation profile of attr along path from resultsLayer's open output file.
AttributeProfile	fetchSpecies (SWMMResultsLayer *resultsLayer, const ProfileBuilder::PathStatic &path, const QString &species, bool nodeScope)
	Species variant (Y2b-2 follow-up, amendment D-Y4): fetches the along-the-path profile of one species — a pollutant or the reserved water-age column — BY NAME, in node or link scope.
AttributeProfile	fetch (SWMMResultsLayer *resultsLayer, const ProfileBuilder::PathStatic &path, PlotAttribute attr)

Function Documentation

fetch() [1/2]

AttributeProfile ProfileAttributeSampler::fetch	(	SWMMResultsLayer *	resultsLayer,
		const ProfileBuilder::PathStatic &	path,
		openswmmvis::plot::PlotAttribute	attr
	)

Fetches the full-simulation profile of attr along path from resultsLayer's open output file.

Returns a default-constructed (empty byPath) profile when the layer is null, has no open output handle, or attr is not trackable.

fetch() [2/2]

AttributeProfile ProfileAttributeSampler::fetch	(	SWMMResultsLayer *	resultsLayer,
		const ProfileBuilder::PathStatic &	path,
		PlotAttribute	attr
	)

Here is the call graph for this function:

fetchSpecies()

AttributeProfile ProfileAttributeSampler::fetchSpecies	(	SWMMResultsLayer *	resultsLayer,
		const ProfileBuilder::PathStatic &	path,
		const QString &	species,
		bool	nodeScope
	)

Species variant (Y2b-2 follow-up, amendment D-Y4): fetches the along-the-path profile of one species — a pollutant or the reserved water-age column — BY NAME, in node or link scope.

The name resolves against the run's live species list at call time (SwmmOutRunLayer::speciesVariableCodeFor), so a reordered model can't repoint the track at a different column. A run that doesn't carry the species leaves every row EMPTY — same "no data ≠ 0.0" contract as the enum overload. attribute in the result stays Unknown; the species identity lives with the caller.

Here is the call graph for this function:

isNodeAttribute()

bool ProfileAttributeSampler::isNodeAttribute ( openswmmvis::plot::PlotAttribute  attr )

inline

True for the six Node* attributes, false for everything else. Inline (header-only) so UI code and tests can classify attributes without linking the sampler's engine/results-layer dependency chain.

Here is the caller graph for this function:

isTrackableAttribute()

bool ProfileAttributeSampler::isTrackableAttribute ( openswmmvis::plot::PlotAttribute  attr )

inline

True when attr is one of the 11 attributes a track can show.

Here is the call graph for this function:

Here is the caller graph for this function: