date.h

/*
** Copyright 2007-2025, RTE (https://www.rte-france.com)
** See AUTHORS.txt
** SPDX-License-Identifier: MPL-2.0
** This file is part of Antares-Simulator,
** Adequacy and Performance assessment for interconnected energy networks.
**
** Antares_Simulator is free software: you can redistribute it and/or modify
** it under the terms of the Mozilla Public Licence 2.0 as published by
** the Mozilla Foundation, either version 2 of the License, or
** (at your option) any later version.
**
** Antares_Simulator is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** Mozilla Public Licence 2.0 for more details.
**
** You should have received a copy of the Mozilla Public Licence 2.0
** along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
*/
#ifndef __ANTARES_LIBS_DATE_DATE_H__
#define __ANTARES_LIBS_DATE_DATE_H__
 
#include <vector>
 
#include <yuni/yuni.h>
#include <yuni/core/string.h>
 
#include "antares/study/fwd.h"
 
namespace Antares
{
enum DayOfTheWeek
{
    monday = 0,
    tuesday,
    wednesday,
    thursday,
    friday,
    saturday,
    sunday
};
 
enum MonthName
{
    january = 0,
    february,
    march,
    april,
    may,
    june,
    july,
    august,
    september,
    october,
    november,
    december
};
 
} // namespace Antares
 
namespace Antares::Date
{
const char* MonthToString(int m, int offset = 0);
 
const char* MonthToLowerString(int m, int offset = 0);
 
const char* MonthToShortString(int m, int offset = 0);
 
const char* MonthToUpperShortString(int m, int offset = 0);
 
bool StringToMonth(MonthName& out, AnyString text);
 
const char* WeekdayToString(int m);
 
const char* WeekdayToShortString(int m);
 
const char* WeekdayToShortUpperString(int m);
 
const char* WeekdayToShortLowerString(int m);
 
const wchar_t* WeekdayToLShortString(int m);
 
bool StringToDayOfTheWeek(DayOfTheWeek& v, const AnyString& text);
 
const char* DayOfTheWeekToString(DayOfTheWeek d);
 
enum Precision
{
    stepNone = 0,
    // stepSecond,
    // stepMinute,
    hourly,
    daily,
    weekly,
    monthly,
    annual,
    stepAny,
};
 
struct HourInterval
{
    uint first;
    uint end;
 
    void reset()
    {
        first = 0;
        end = 0;
    }
}; // class HourInterval
 
struct DayInterval
{
    uint first;
    uint end;
 
    uint numberOfWeeks() const;
 
    void reset()
    {
        first = 0;
        end = 0;
    }
}; // class DayInterval
 
class Calendar final
{
public:
    using ShortString42 = Yuni::CString<41, false>;
    using ShortString12 = Yuni::CString<11, false>;
    using ShortString8 = Yuni::CString<7, false>;
 
    enum
    {
        maxHoursInYear = 24 * 366,
        maxDaysInYear = 366,
        maxWeeksInYear = 54,
    };
 
    // calendar settings
    struct
    {
        DayOfTheWeek weekday;
        uint dayYear;
        uint dayMonth;
        uint dayHour;
        uint month;
        uint week;
        bool firstHourInDay;
        bool firstHourInMonth;
    } hours[maxHoursInYear];
 
    // calendar settings
    struct
    {
        DayOfTheWeek weekday;
        HourInterval hours;
        uint month;
        uint dayMonth;
        uint week;
    } days[maxDaysInYear];
 
    struct
    {
        HourInterval hours;
        DayInterval daysYear;
        uint days;
        // Final users prefer that weeks numbers are stable whatever the first month
        // of simulation is. If the 1st january is the same than the first weekday,
        // the week number for this day will be 1, 53 otherwise.
        uint userweek;
    } weeks[maxWeeksInYear];
 
    struct
    {
        HourInterval hours;
        uint days;
        DayInterval daysYear;
        DayOfTheWeek firstWeekday;
        MonthName realmonth;
    } months[12 + 1]; // september..august for example
 
    struct
    {
        uint months[12 /*january..december*/];
    } mapping;
 
    struct Settings
    {
        DayOfTheWeek weekday1rstJanuary;
        DayOfTheWeek weekFirstDay;
        MonthName firstMonth;
        bool leapYear;
    };
 
    struct
    {
        struct
        {
            ShortString12 name;
            ShortString8 shortName;
            ShortString8 shortUpperName;
        } months[12];
 
        ShortString42 hours[maxHoursInYear];
        ShortString42 daysYear[maxHoursInYear];
        ShortString12 weekdays[7];
    } text;
 
    struct
    {
        std::wstring hours[maxHoursInYear];
    } wtext;
 
public:
 
 
    Calendar();
 
    ~Calendar()
    {
    }
 
 
    void reset();
 
    void reset(Settings settings);
 
    bool saveToCSVFile(const AnyString& filename) const;
 
private:
    Settings settings_;
 
}; // class Calendar
} // namespace Antares::Date
 
#endif // __ANTARES_TOOLBOX_DATE_H__