ORE Studio 0.0.4
Loading...
Searching...
No Matches
zero_convention.hpp
1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 *
3 * Copyright (C) 2026 Marco Craveiro <marco.craveiro@gmail.com>
4 *
5 * This program is free software; you can redistribute it and/or modify it under
6 * the terms of the GNU General Public License as published by the Free Software
7 * Foundation; either version 3 of the License, or (at your option) any later
8 * version.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
13 * details.
14 *
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 *
19 */
20#ifndef ORES_REFDATA_DOMAIN_ZERO_CONVENTION_HPP
21#define ORES_REFDATA_DOMAIN_ZERO_CONVENTION_HPP
22
23#include <chrono>
24#include <string>
25#include <optional>
26#include "ores.utility/uuid/tenant_id.hpp"
27
28namespace ores::refdata::domain {
29
37struct zero_convention final {
41 int version = 0;
42
47
53 std::string id;
54
58 bool tenor_based = false;
59
63 std::string day_count_fraction;
64
68 std::optional<std::string> compounding;
69
73 std::optional<std::string> compounding_frequency;
74
78 std::optional<std::string> tenor_calendar;
79
83 std::optional<int> spot_lag;
84
88 std::optional<std::string> spot_calendar;
89
93 std::optional<std::string> roll_convention;
94
98 std::optional<bool> end_of_month;
99
103 std::string modified_by;
104
108 std::string performed_by;
109
116
120 std::string change_commentary;
121
125 std::chrono::system_clock::time_point recorded_at;
126};
127
128}
129
130#endif
Domain types for risk management.
Definition EntityDetailOperations.hpp:193
Conventions for a zero-coupon yield curve.
Definition zero_convention.hpp:37
std::string modified_by
Username of the person who last modified this zero convention.
Definition zero_convention.hpp:103
std::optional< std::string > compounding
Compounding method (canonical CDM, e.g. 'Continuous'). Present only when tenor_based is true.
Definition zero_convention.hpp:68
std::string change_commentary
Free-text commentary explaining the change.
Definition zero_convention.hpp:120
std::string day_count_fraction
Day count fraction code (canonical FpML, e.g. 'ACT/365.FIXED').
Definition zero_convention.hpp:63
std::optional< int > spot_lag
Number of business days from today to the spot date.
Definition zero_convention.hpp:83
std::chrono::system_clock::time_point recorded_at
Timestamp when this version of the record was recorded.
Definition zero_convention.hpp:125
std::optional< std::string > spot_calendar
Calendar used to compute the spot date.
Definition zero_convention.hpp:88
int version
Version number for optimistic locking and change tracking.
Definition zero_convention.hpp:41
std::optional< std::string > roll_convention
Business day convention applied to tenor dates (canonical FpML).
Definition zero_convention.hpp:93
bool tenor_based
Whether the curve is defined on a tenor grid (true) or on absolute dates (false).
Definition zero_convention.hpp:58
std::optional< bool > end_of_month
Whether end-of-month convention applies.
Definition zero_convention.hpp:98
std::optional< std::string > tenor_calendar
Calendar used to determine tenor dates (e.g. 'TARGET').
Definition zero_convention.hpp:78
std::string performed_by
Username of the account that performed this action.
Definition zero_convention.hpp:108
std::optional< std::string > compounding_frequency
Frequency at which the rate is compounded (canonical CDM). Present only when compounding is 'Compound...
Definition zero_convention.hpp:73
utility::uuid::tenant_id tenant_id
Tenant identifier for multi-tenancy isolation.
Definition zero_convention.hpp:46
std::string change_reason_code
Code identifying the reason for the change.
Definition zero_convention.hpp:115
std::string id
Unique convention identifier.
Definition zero_convention.hpp:53
A strongly-typed wrapper around a UUID representing a tenant identifier.
Definition tenant_id.hpp:66
static tenant_id system()
Creates a tenant_id representing the system tenant.
Definition tenant_id.cpp:41