cppDataPipeline 0.3.0
C++ Implementation of the FAIR Data Pipeline API
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
FairDataPipeline::DataPipeline::impl Class Reference

Public Types

typedef std::shared_ptr< implsptr
 

Public Member Functions

 ~impl ()=default
 Default Destructor. More...
 
ghc::filesystem::path link_read (std::string &data_product)
 Return a path to a given data product Whilst recording it's meta data for the code run. More...
 
ghc::filesystem::path link_write (std::string &data_product)
 Return a path to be used for a given data product whilst recording it's meta data. More...
 
void finalise ()
 Finalise the pipeline Record all data products and meta data to the registry update the code run with all appropriate meta data. More...
 
std::string get_code_run_uuid () const
 Get the code run uuid. More...
 

Static Public Member Functions

static sptr construct (const ghc::filesystem::path &config_file_path, const ghc::filesystem::path &file_system_path, const std::string &token, RESTAPI api_location=RESTAPI::LOCAL)
 construct a DataPipelineImpl_ instance from configurations and setup More...
 

Constructor & Destructor Documentation

◆ ~impl()

FairDataPipeline::DataPipeline::impl::~impl ( )
default

Default Destructor.

Member Function Documentation

◆ construct()

DataPipeline::impl::sptr FairDataPipeline::DataPipeline::impl::construct ( const ghc::filesystem::path &  config_file_path,
const ghc::filesystem::path &  file_system_path,
const std::string &  token,
RESTAPI  api_location = RESTAPI::LOCAL 
)
static

construct a DataPipelineImpl_ instance from configurations and setup


Parameters
config_file_pathlocation of the local configuration file
access_token_fileAPI authorisation token where required
log_levellevel for the output logging statements
api_locationwhether to use local/remote RestAPI endpoint

◆ finalise()

void FairDataPipeline::DataPipeline::impl::finalise ( )

Finalise the pipeline Record all data products and meta data to the registry update the code run with all appropriate meta data.

◆ get_code_run_uuid()

std::string FairDataPipeline::DataPipeline::impl::get_code_run_uuid ( ) const

Get the code run uuid.

Returns
std::string

◆ link_read()

ghc::filesystem::path FairDataPipeline::DataPipeline::impl::link_read ( std::string &  data_product)

Return a path to a given data product Whilst recording it's meta data for the code run.

Parameters
data_product
Returns
ghc::filesystem::path

◆ link_write()

ghc::filesystem::path FairDataPipeline::DataPipeline::impl::link_write ( std::string &  data_product)

Return a path to be used for a given data product whilst recording it's meta data.

Parameters
data_product
Returns
ghc::filesystem::path

The documentation for this class was generated from the following file: