Report2DVars.hpp File Reference

Header-only token ↔ bitmask helpers for [2D_OPTIONS] REPORT_2D_VARIABLES / REPORT_2D_SPECIES / REPORT_2D_STEP. More...

#include "SolverOptions2D.hpp"
#include <cctype>
#include <cstdio>
#include <string>
#include <vector>

Include dependency graph for Report2DVars.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	openswmm
namespace	openswmm::twoD
namespace	openswmm::twoD::report2d
	Dataset groups the 2D results writer can emit ([2D_OPTIONS] REPORT_2D_VARIABLES). One bit per group; the tokens are the names below. Unselected groups are NOT created in the file, so readers treat every time-varying dataset as optional.

Functions
const std::vector< std::string > &	openswmm::twoD::report2d::tokens ()
	Group tokens in bit order (index i ↔ bit 1u << i).
bool	openswmm::twoD::report2d::iequalsTok (const std::string &a, const char *b)
std::vector< std::string >	openswmm::twoD::report2d::splitList (const std::string &text)
	Split on whitespace / commas.
std::string	openswmm::twoD::report2d::parseMask (const std::string &text, unsigned &mask)
	Parse a token list or a preset (DEFAULT | MINIMAL | ALL | NONE) into a bitmask. DEPTH is always included — every reader keys the time axis on it. Returns an error string, empty on success.
std::string	openswmm::twoD::report2d::formatMask (unsigned mask)
	Preset name when the mask equals one, else the space-separated token list.
std::string	openswmm::twoD::report2d::formatSpecies (const std::vector< std::string > &species)
	"ALL" for an empty (unfiltered) list, else the space-separated names.
std::vector< std::string >	openswmm::twoD::report2d::parseSpecies (const std::string &text)
	Species list from text; "ALL" (alone) → empty list.
std::string	openswmm::twoD::report2d::formatStep (double seconds)
	HH:MM:SS (REPORT_STEP spelling).

Detailed Description

Header-only token ↔ bitmask helpers for [2D_OPTIONS] REPORT_2D_VARIABLES / REPORT_2D_SPECIES / REPORT_2D_STEP.

Shared by the [2D_OPTIONS] parser (SectionHandlers2D, 2D builds only), the .inp writer and the GeoPackage writer/reader (compiled in every build), so the vocabulary lives in one place and no non-2D build gains a link dependency on the 2D TU.

Author

Caleb Buahin caleb.nosp@m..bua.nosp@m.hin@g.nosp@m.mail.nosp@m..com

Copyright

Copyright (c) 2026 Caleb Buahin. All rights reserved.

License\n Apache-2.0