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
52
53#ifndef OPENSWMM_GEOPACKAGE_HOTSTART_FORMAT_HPP
54#define OPENSWMM_GEOPACKAGE_HOTSTART_FORMAT_HPP
55
56#include "FormatTypes.hpp"
57
58#include <string>
59
61
80FormatResult parseHotstartHsf(const std::string& path, HotstartSnapshot& snapshot,
81 const HsfLayout& layout = {});
82
99FormatResult writeHotstartHsf(const std::string& path, const HotstartSnapshot& snapshot);
100
101} // namespace openswmm::gpkg::formats
102
103#endif // OPENSWMM_GEOPACKAGE_HOTSTART_FORMAT_HPP
Plain-data types shared by every external-file format parser.
Definition ClimateFormat.cpp:36
FormatResult parseHotstartHsf(const std::string &path, HotstartSnapshot &snapshot, const HsfLayout &layout)
Read legacy-layout hot-start records and preserve raw runoff/trailer bytes.
Definition HotstartFormat.cpp:117
FormatResult writeHotstartHsf(const std::string &path, const HotstartSnapshot &snapshot)
Write retained legacy hot-start routing records and opaque raw sections.
Definition HotstartFormat.cpp:251
Lightweight outcome for format parse / materialise calls.
Definition FormatTypes.hpp:204
Top-level snapshot — header plus per-object vectors.
Definition FormatTypes.hpp:167
What the model says about a file's layout that the file does not.
Definition FormatTypes.hpp:187