ORE Studio 0.0.4
Loading...
Searching...
No Matches
Public Attributes | List of all members
methodology Struct Referencefinal

Describes a methodology for data processing or transformation. More...

#include <methodology.hpp>

Collaboration diagram for methodology:
Collaboration graph

Public Attributes

int version = 0
 Version number for optimistic locking and change tracking.
 
boost::uuids::uuid id
 UUID uniquely identifying this methodology.
 
std::string name
 Human-readable name for the methodology.
 
std::string description
 Detailed description of the methodology's purpose and approach.
 
std::optional< std::string > logic_reference
 Optional reference to external documentation of the methodology logic.
 
std::optional< std::string > implementation_details
 Optional details about how the methodology is implemented.
 
std::string recorded_by
 Username of the person who last modified this methodology.
 
std::string change_commentary
 Free-text commentary explaining the change.
 
std::chrono::system_clock::time_point recorded_at
 Timestamp when this version of the record was recorded.
 

Detailed Description

Describes a methodology for data processing or transformation.

Member Data Documentation

◆ id

boost::uuids::uuid id

UUID uniquely identifying this methodology.

This is the surrogate key for the methodology.

◆ logic_reference

std::optional<std::string> logic_reference

Optional reference to external documentation of the methodology logic.

Typically a URL or document reference.