FairDataPipeline::IOObject Class Reference

Class for API objects. More...

#include <fdp/objects/io_object.hxx>

Public Member Functions
	IOObject ()=default
	Construct a new IOObject object (empty constructor) More...
	IOObject (const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, const std::string &data_product_description, bool isPublic)
	Construct a new IOObject object Used to store inputs and outputs for in the config. More...
	IOObject (const std::string &data_product, const std::string &use_data_product, const std::string &use_version, const std::string &use_namespace, ghc::filesystem::path path, ApiObject &component_obj, ApiObject &data_product_obj)
	Construct a new IOObject object Used to store inputs and outputs for in the config. More...
const std::string &	get_data_product () const
	Get the data product as a string. More...
const std::string &	get_use_data_product () const
	Get the use data product as a string. More...
const std::string &	get_use_component () const
	Get the use component as a string. More...
const std::string &	get_use_version () const
	Get the use version as a string. More...
const std::string &	get_use_namespace () const
	Get the use namespace as a string. More...
ghc::filesystem::path	get_path () const
	Get the path of the data product. More...
const std::string &	get_data_product_description () const
	Get the data product description as a string. More...
const std::string &	get_component_description () const
	Get the component description as a string. More...
bool	is_public () const
	Check whether the data product is public. More...
ApiObject::sptr	get_component_object () const
	Get the component object object. More...
ApiObject::sptr	get_data_product_object () const
	Get the data product object object. More...
void	set_component_object (ApiObject &component_obj)
	Set the component object object. More...
void	set_data_product_object (ApiObject &data_product_obj)
	Set the data product object object. More...

Detailed Description

Class for API objects.

Constructor & Destructor Documentation

IOObject() [1/3]

FairDataPipeline::IOObject::IOObject ( )

default

Construct a new IOObject object (empty constructor)

IOObject() [2/3]

FairDataPipeline::IOObject::IOObject ( const std::string &  data_product, const std::string &  use_data_product, const std::string &  use_version, const std::string &  use_namespace, ghc::filesystem::path  path, const std::string &  data_product_description, bool  isPublic  )

inline

Construct a new IOObject object Used to store inputs and outputs for in the config.

Parameters

data_product	data_product name as string
use_data_product	data_product name to be used as string
use_version	data_product version to be used as string
use_namespace	namespace to be used as string
path	file path to data_product
data_product_description	data product description
isPublic	whether or not the data product should be public

IOObject() [3/3]

FairDataPipeline::IOObject::IOObject ( const std::string &  data_product, const std::string &  use_data_product, const std::string &  use_version, const std::string &  use_namespace, ghc::filesystem::path  path, ApiObject &  component_obj, ApiObject &  data_product_obj  )

inline

Construct a new IOObject object Used to store inputs and outputs for in the config.

Parameters

data_product	data_product name as string
use_data_product	data_product name to be used as string
use_version	data_product version to be used as string
use_namespace	namespace to be used as string
path	file path to data_product
component_obj	the data_product component object as a shared pointer
data_product_obj	the data_product object as a shared pointer

Member Function Documentation

get_component_description()

const std::string & FairDataPipeline::IOObject::get_component_description ( ) const

inline

Get the component description as a string.

Returns

std::string

get_component_object()

ApiObject::sptr FairDataPipeline::IOObject::get_component_object ( ) const

inline

Get the component object object.

Returns

std::shared_ptr<ApiObject>

get_data_product()

const std::string & FairDataPipeline::IOObject::get_data_product ( ) const

inline

Get the data product as a string.

Returns

const std::string&

get_data_product_description()

const std::string & FairDataPipeline::IOObject::get_data_product_description ( ) const

inline

Get the data product description as a string.

Returns

std::string

get_data_product_object()

ApiObject::sptr FairDataPipeline::IOObject::get_data_product_object ( ) const

inline

Get the data product object object.

Returns

std::shared_ptr<ApiObject>

get_path()

ghc::filesystem::path FairDataPipeline::IOObject::get_path ( ) const

inline

Get the path of the data product.

Returns

ghc::filesystem::path

get_use_component()

const std::string & FairDataPipeline::IOObject::get_use_component ( ) const

inline

Get the use component as a string.

Returns

const std::string&

get_use_data_product()

const std::string & FairDataPipeline::IOObject::get_use_data_product ( ) const

inline

Get the use data product as a string.

Returns

const std::string&

get_use_namespace()

const std::string & FairDataPipeline::IOObject::get_use_namespace ( ) const

inline

Get the use namespace as a string.

Returns

const std::string&

get_use_version()

const std::string & FairDataPipeline::IOObject::get_use_version ( ) const

inline

Get the use version as a string.

Returns

const std::string&

is_public()

bool FairDataPipeline::IOObject::is_public ( ) const

inline

Check whether the data product is public.

Returns

true the data product is public

false the data product is not public

set_component_object()

void FairDataPipeline::IOObject::set_component_object ( ApiObject &  component_obj )

inline

Set the component object object.

Parameters

component_obj

set_data_product_object()

void FairDataPipeline::IOObject::set_data_product_object ( ApiObject &  data_product_obj )

inline

Set the data product object object.

Parameters

data_product_obj

---

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

• include/fdp/objects/io_object.hxx