ORE Studio 0.0.4
Loading...
Searching...
No Matches
methodology.hpp
1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 *
3 * Copyright (C) 2025 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_DQ_DOMAIN_METHODOLOGY_HPP
21#define ORES_DQ_DOMAIN_METHODOLOGY_HPP
22
23#include <chrono>
24#include <optional>
25#include <string>
26#include <boost/uuid/uuid.hpp>
27
28namespace ores::dq::domain {
29
33struct methodology final {
37 int version = 0;
38
44 boost::uuids::uuid id;
45
49 std::string name;
50
54 std::string description;
55
61 std::optional<std::string> logic_reference;
62
66 std::optional<std::string> implementation_details;
67
71 std::string recorded_by;
72
76 std::string change_commentary;
77
81 std::chrono::system_clock::time_point recorded_at;
82};
83
84}
85
86#endif
Describes a methodology for data processing or transformation.
Definition methodology.hpp:33
std::string change_commentary
Free-text commentary explaining the change.
Definition methodology.hpp:76
std::string description
Detailed description of the methodology's purpose and approach.
Definition methodology.hpp:54
std::optional< std::string > logic_reference
Optional reference to external documentation of the methodology logic.
Definition methodology.hpp:61
std::optional< std::string > implementation_details
Optional details about how the methodology is implemented.
Definition methodology.hpp:66
std::chrono::system_clock::time_point recorded_at
Timestamp when this version of the record was recorded.
Definition methodology.hpp:81
std::string name
Human-readable name for the methodology.
Definition methodology.hpp:49
std::string recorded_by
Username of the person who last modified this methodology.
Definition methodology.hpp:71
boost::uuids::uuid id
UUID uniquely identifying this methodology.
Definition methodology.hpp:44
int version
Version number for optimistic locking and change tracking.
Definition methodology.hpp:37