ORE Studio 0.0.4
Loading...
Searching...
No Matches
fx_digital_option_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_FX_DIGITAL_OPTION_INSTRUMENT_HPP
21#define ORES_TRADING_DOMAIN_FX_DIGITAL_OPTION_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
43 int version = 0;
45
49 boost::uuids::uuid instrument_id;
50
51 boost::uuids::uuid party_id;
52 std::optional<boost::uuids::uuid> trade_id;
53
58 std::string trade_type_code;
59
63 std::string foreign_currency;
64
68 std::string domestic_currency;
69
73 std::string payoff_currency;
74
78 double payoff_amount = 0.0;
79
83 std::string option_type;
84
88 std::string expiry_date;
89
93 std::string long_short;
94
98 std::optional<double> strike;
99
104 std::string barrier_type;
105
109 std::optional<double> lower_barrier;
110
114 std::optional<double> upper_barrier;
115
116 std::string description;
117 std::string modified_by;
118 std::string performed_by;
119 std::string change_reason_code;
120 std::string change_commentary;
121 std::chrono::system_clock::time_point recorded_at;
122};
123
124}
125
126#endif
FX Digital Option instrument.
Definition fx_digital_option_instrument.hpp:42
std::string option_type
Option type: Call or Put. Empty for touch options.
Definition fx_digital_option_instrument.hpp:83
std::string long_short
Position direction: Long or Short.
Definition fx_digital_option_instrument.hpp:93
boost::uuids::uuid instrument_id
UUID uniquely identifying this FX digital option instrument.
Definition fx_digital_option_instrument.hpp:49
std::string payoff_currency
Currency in which the payoff is denominated.
Definition fx_digital_option_instrument.hpp:73
std::optional< double > lower_barrier
Primary barrier level. Absent for plain digital options.
Definition fx_digital_option_instrument.hpp:109
std::optional< double > upper_barrier
Second barrier level for FxDoubleTouchOption.
Definition fx_digital_option_instrument.hpp:114
double payoff_amount
Fixed payoff amount. Must be positive.
Definition fx_digital_option_instrument.hpp:78
std::string domestic_currency
DomesticCurrency from ORE XML (quote / settlement currency).
Definition fx_digital_option_instrument.hpp:68
std::string expiry_date
Option expiry date (ISO 8601 date string).
Definition fx_digital_option_instrument.hpp:88
std::string foreign_currency
ForeignCurrency from ORE XML (source / underlying currency).
Definition fx_digital_option_instrument.hpp:63
std::optional< double > strike
Strike level. Absent for touch options.
Definition fx_digital_option_instrument.hpp:98
std::string trade_type_code
ORE product type code. One of: FxDigitalOption, FxDigitalBarrierOption, FxTouchOption,...
Definition fx_digital_option_instrument.hpp:58
std::string barrier_type
Barrier type (e.g. DownAndIn, DownAndOut, KnockIn, KnockOut). Absent for plain digital options.
Definition fx_digital_option_instrument.hpp:104
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