ORE Studio 0.0.4
Loading...
Searching...
No Matches
coding_scheme.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_CODING_SCHEME_HPP
21#define ORES_DQ_DOMAIN_CODING_SCHEME_HPP
22
23#include <chrono>
24#include <optional>
25#include <string>
26
27namespace ores::dq::domain {
28
36struct coding_scheme final {
40 int version = 0;
41
48 std::string code;
49
53 std::string name;
54
60 std::string authority_type;
61
67 std::string subject_area_name;
68
74 std::string domain_name;
75
79 std::optional<std::string> uri;
80
84 std::string description;
85
89 std::string recorded_by;
90
94 std::string change_commentary;
95
99 std::chrono::system_clock::time_point recorded_at;
100};
101
102}
103
104#endif
Defines a coding or identification standard used to identify entities.
Definition coding_scheme.hpp:36
std::string domain_name
Data domain this scheme applies to.
Definition coding_scheme.hpp:74
std::optional< std::string > uri
Optional URI pointing to the official scheme definition.
Definition coding_scheme.hpp:79
std::string change_commentary
Free-text commentary explaining the change.
Definition coding_scheme.hpp:94
std::string description
Human-readable description of the coding scheme's purpose.
Definition coding_scheme.hpp:84
std::string authority_type
Type of authority that maintains this scheme.
Definition coding_scheme.hpp:60
std::string code
Unique code identifying this coding scheme.
Definition coding_scheme.hpp:48
std::chrono::system_clock::time_point recorded_at
Timestamp when this version of the record was recorded.
Definition coding_scheme.hpp:99
std::string name
Human-readable name for the coding scheme.
Definition coding_scheme.hpp:53
std::string recorded_by
Username of the person who last modified this scheme.
Definition coding_scheme.hpp:89
int version
Version number for optimistic locking and change tracking.
Definition coding_scheme.hpp:40
std::string subject_area_name
Subject area this scheme belongs to.
Definition coding_scheme.hpp:67