OpenSWMM Engine  6.0.0-alpha.4
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.4)
Loading...
Searching...
No Matches
HotstartFormat.hpp
Go to the documentation of this file.
1// SPDX-License-Identifier: Apache-2.0
2//
3// Copyright 2026 Caleb Buahin
4//
5// Licensed under the Apache License, Version 2.0 (the "License");
6// you may not use this file except in compliance with the License.
7// You may obtain a copy of the License at
8//
9// http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing, software
12// distributed under the License is distributed on an "AS IS" BASIS,
13// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14// See the License for the specific language governing permissions and
15// limitations under the License.
16
55
56#ifndef OPENSWMM_GEOPACKAGE_HOTSTART_FORMAT_HPP
57#define OPENSWMM_GEOPACKAGE_HOTSTART_FORMAT_HPP
58
59#include "FormatTypes.hpp"
60
61#include <string>
62
64
76FormatResult parseHotstartHsf(const std::string& path,
77 HotstartSnapshot& snapshot);
78
87FormatResult writeHotstartHsf(const std::string& path,
88 const HotstartSnapshot& snapshot);
89
90} // namespace openswmm::gpkg::formats
91
92#endif // OPENSWMM_GEOPACKAGE_HOTSTART_FORMAT_HPP
Plain-data types shared by every external-file format parser.
Definition ClimateFormat.cpp:35
FormatResult writeHotstartHsf(const std::string &path, const HotstartSnapshot &snapshot)
Write a HotstartSnapshot to an HSF v4 file at path.
Definition HotstartFormat.cpp:179
FormatResult parseHotstartHsf(const std::string &path, HotstartSnapshot &snapshot)
Parse an HSF v4 file into a HotstartSnapshot.
Definition HotstartFormat.cpp:65
Lightweight outcome for format parse / materialise calls.
Definition FormatTypes.hpp:181
Top-level snapshot — header plus per-object vectors.
Definition FormatTypes.hpp:163