DataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline. More...

#include <fdp/fdp.hxx>

Public Types
typedef std::shared_ptr< DataPipeline >	sptr

Public Member Functions
	~DataPipeline ()
	Destroy the Data Pipeline object. More...

std::string	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...

std::string	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...

Static Public Member Functions
static sptr	construct (const std::string &config_file_path, const std::string &script_file_path, std::string token="")
	Construct a new Data Pipeline (PIMPL) More...

Detailed Description

DataPipeline Class: A PIMPL Class for interacting the the FAIR Data Pipeline.

Constructor & Destructor Documentation

FairDataPipeline::DataPipeline::~DataPipeline ( )

default

Destroy the Data Pipeline object.

DataPipeline::sptr FairDataPipeline::DataPipeline::construct	(	const std::string &	config_file_path,
		const std::string &	script_file_path,
		std::string	token = `""`
	)

static

Construct a new Data Pipeline (PIMPL)

Parameters

void FairDataPipeline::DataPipeline::finalise ( )

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

std::string FairDataPipeline::DataPipeline::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

std::string FairDataPipeline::DataPipeline::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

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