#include <CheckpointInspection.hpp>

Collaboration diagram for openswmm::CheckpointInspection:

Classes
struct	Companion

struct	Driver

struct	Reports

Public Member Functions
std::string	json () const
	Serialize exact checkpoint inspection metadata as compact schema-one JSON.

bool	operator== (const CheckpointInspection &other) const =default
	Compare all CheckpointInspection fields using default member equality.

Public Attributes
uint32_t	schema_version = 1

double	engine_seconds = 0

double	engine_date = 0

double	start_date = 0

double	report_start_date = 0

double	next_report_seconds = 0

uint64_t	checkpoint_bytes = 0

std::optional< double >	completed_source_seconds

std::optional< Driver >	driver

Reports	binary

Reports	mesh

bool	file_outputs = false

bool	relocatable_bundle = false

bool	detailed_sources = false

uint64_t	source_frames = 0

uint64_t	source_prefix_bytes = 0

std::vector< Companion >	companions

Detailed Description

Internal schema for a compatible fresh session's validated saved state. Inspection prepares/discards output copies; it never installs or publishes. Dates use the engine calendar; elapsed times and cadences use seconds.

Member Function Documentation

◆ json()

std::string openswmm::CheckpointInspection::json ( ) const

Serialize exact checkpoint inspection metadata as compact schema-one JSON.

Serializes engine calendar dates and elapsed/cadence seconds as documented by fields, without output installation or file access. Rejects unsupported schema, nonfinite floating fields, invalid UTF-8 and invalid companion role with std::logic_error. Does not independently prove checkpoint/model compatibility or nonnegative semantic ranges; allocation can throw.

Returns: Owned UTF-8 JSON; uint64 counts are decimal strings to preserve full integer precision.

Here is the caller graph for this function:

◆ operator==()

bool openswmm::CheckpointInspection::operator== ( const CheckpointInspection & other ) const

default

Compare all CheckpointInspection fields using default member equality.

Parameters

[in] other Borrowed metadata value to compare; no filesystem, schema or compatibility validation.

Returns: True when every corresponding member compares equal; optional/vector/string comparisons follow their value semantics.

Member Data Documentation

◆ binary

Reports openswmm::CheckpointInspection::binary

◆ checkpoint_bytes

uint64_t openswmm::CheckpointInspection::checkpoint_bytes = 0

◆ companions

std::vector<Companion> openswmm::CheckpointInspection::companions

◆ completed_source_seconds

std::optional<double> openswmm::CheckpointInspection::completed_source_seconds

◆ detailed_sources

bool openswmm::CheckpointInspection::detailed_sources = false

◆ driver

std::optional<Driver> openswmm::CheckpointInspection::driver

◆ engine_date

double openswmm::CheckpointInspection::engine_date = 0

◆ engine_seconds

double openswmm::CheckpointInspection::engine_seconds = 0

◆ file_outputs

bool openswmm::CheckpointInspection::file_outputs = false

◆ mesh

Reports openswmm::CheckpointInspection::mesh

◆ next_report_seconds

double openswmm::CheckpointInspection::next_report_seconds = 0

◆ relocatable_bundle

bool openswmm::CheckpointInspection::relocatable_bundle = false

◆ report_start_date

double openswmm::CheckpointInspection::report_start_date = 0

◆ schema_version

uint32_t openswmm::CheckpointInspection::schema_version = 1

◆ source_frames

uint64_t openswmm::CheckpointInspection::source_frames = 0

◆ source_prefix_bytes

uint64_t openswmm::CheckpointInspection::source_prefix_bytes = 0

◆ start_date

double openswmm::CheckpointInspection::start_date = 0

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

/home/runner/work/openswmm.engine/openswmm.engine/src/engine/core/CheckpointInspection.hpp
/home/runner/work/openswmm.engine/openswmm.engine/src/engine/core/CheckpointInspection.cpp

Classes

Public Member Functions

Public Attributes