openswmm::twoD::SurfaceOwnershipPreview Struct Reference

#include <SurfaceOwnership.hpp>

Collaboration diagram for openswmm::twoD::SurfaceOwnershipPreview:

Public Member Functions
bool	valid () const
	Test whether preview validation collected any error diagnostics.

Public Attributes
std::vector< SurfaceOwnerObject >	objects
std::vector< SurfaceOwnerShare >	shares
std::vector< double >	mesh_weather_area
std::vector< std::string >	errors
std::string	token
bool	cancelled = false

Member Function Documentation

valid()

bool openswmm::twoD::SurfaceOwnershipPreview::valid ( ) const

inline

Test whether preview validation collected any error diagnostics.

Returns

errors.empty(). Cancellation and each object's status are separate fields and are not checked, so callers must inspect cancelled before treating the preview as complete/usable. No model activation, mutation or allocation occurs.

Here is the caller graph for this function:

Member Data Documentation

cancelled

bool openswmm::twoD::SurfaceOwnershipPreview::cancelled = false

errors

std::vector<std::string> openswmm::twoD::SurfaceOwnershipPreview::errors

mesh_weather_area

std::vector<double> openswmm::twoD::SurfaceOwnershipPreview::mesh_weather_area

objects

std::vector<SurfaceOwnerObject> openswmm::twoD::SurfaceOwnershipPreview::objects

shares

std::vector<SurfaceOwnerShare> openswmm::twoD::SurfaceOwnershipPreview::shares

token

std::string openswmm::twoD::SurfaceOwnershipPreview::token

---

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

• /home/runner/work/openswmm.engine/openswmm.engine/src/engine/2d/subsurface/SurfaceOwnership.hpp