ORE Studio 0.0.4
Loading...
Searching...
No Matches
swaption_instrument.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_TRADING_DOMAIN_SWAPTION_INSTRUMENT_HPP
21#define ORES_TRADING_DOMAIN_SWAPTION_INSTRUMENT_HPP
22
23#include <chrono>
24#include <optional>
25#include <string>
26#include <boost/uuid/uuid.hpp>
27#include "ores.utility/uuid/tenant_id.hpp"
28
29namespace ores::trading::domain {
30
38struct swaption_instrument final {
42 int version = 0;
43
48
54 boost::uuids::uuid instrument_id;
55
61 boost::uuids::uuid party_id;
62
68 std::optional<boost::uuids::uuid> trade_id;
69
75 std::string expiry_date;
76
82 std::string exercise_type;
83
89 std::string settlement_type;
90
96 std::string long_short;
97
103 std::string start_date;
104
110 std::string maturity_date;
111
117 std::string description;
118
122 std::string modified_by;
123
127 std::string performed_by;
128
135
139 std::string change_commentary;
140
144 std::chrono::system_clock::time_point recorded_at;
145};
146
147}
148
149#endif
Swaption (option on an interest rate swap) instrument.
Definition swaption_instrument.hpp:38
std::string modified_by
Username of the person who last modified this swaption instrument.
Definition swaption_instrument.hpp:122
std::string long_short
Position direction: Long or Short.
Definition swaption_instrument.hpp:96
boost::uuids::uuid instrument_id
UUID uniquely identifying this swaption instrument.
Definition swaption_instrument.hpp:54
std::optional< boost::uuids::uuid > trade_id
Optional soft FK to the parent trade.
Definition swaption_instrument.hpp:68
std::string exercise_type
Exercise type: European, Bermudan, or American.
Definition swaption_instrument.hpp:82
std::string start_date
Optional underlying swap start date.
Definition swaption_instrument.hpp:103
std::string change_commentary
Free-text commentary explaining the change.
Definition swaption_instrument.hpp:139
std::string description
Optional free-text description.
Definition swaption_instrument.hpp:117
std::string settlement_type
Settlement type: Cash or Physical.
Definition swaption_instrument.hpp:89
boost::uuids::uuid party_id
Party that owns this instrument.
Definition swaption_instrument.hpp:61
std::chrono::system_clock::time_point recorded_at
Timestamp when this version of the record was recorded.
Definition swaption_instrument.hpp:144
int version
Version number for optimistic locking and change tracking.
Definition swaption_instrument.hpp:42
std::string expiry_date
Option expiry date.
Definition swaption_instrument.hpp:75
std::string maturity_date
Optional underlying swap maturity date.
Definition swaption_instrument.hpp:110
std::string performed_by
Username of the account that performed this action.
Definition swaption_instrument.hpp:127
utility::uuid::tenant_id tenant_id
Tenant identifier for multi-tenancy isolation.
Definition swaption_instrument.hpp:47
std::string change_reason_code
Code identifying the reason for the change.
Definition swaption_instrument.hpp:134
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