openswmm_datetime.h

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2026 Caleb Buahin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

 
#ifndef OPENSWMM_ENGINE_DATETIME_H
#define OPENSWMM_ENGINE_DATETIME_H
 
#include "openswmm_engine_export.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* =========================================================================
 * Epoch constant
 * ========================================================================= */

#define SWMM_DATETIME_DATE_DELTA 693594
 
/* =========================================================================
 * Encode (calendar parts -> SWMM DateTime double)
 * ========================================================================= */

SWMM_ENGINE_API int swmm_datetime_encode_date(int year, int month, int day,
                                              double* out);

SWMM_ENGINE_API int swmm_datetime_encode_time(int hour, int minute, int second,
                                              double* out);
 
/* =========================================================================
 * Decode (SWMM DateTime double -> calendar parts)
 * ========================================================================= */

SWMM_ENGINE_API int swmm_datetime_decode_date(double value,
                                              int* year, int* month, int* day);

SWMM_ENGINE_API int swmm_datetime_decode_time(double value,
                                              int* hour, int* minute, int* second);
 
/* =========================================================================
 * DateTime arithmetic
 * ========================================================================= */

SWMM_ENGINE_API int swmm_datetime_add_seconds(double value, double seconds,
                                              double* out);

SWMM_ENGINE_API int swmm_datetime_time_diff(double value1, double value2,
                                            long* out);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OPENSWMM_ENGINE_DATETIME_H */