Encapsulate a task for writing data to a destination. Containes a callable 'writer' responisible for writing data to a held dataset. Contains a callabel 'build_dataset' which builds or opens a dataset for writing to in a held HDFGroup. A WriteTask is bound to a group for its entire lifetime. More...

#include <write_task.hh>

Public Types
using	BasegroupBuilder = BGB

using	Writer = DW

using	Builder = DB

using	AttributeWriterGroup = AWG

using	AttributeWriterDataset = AWD

Public Member Functions
std::string	get_active_path ()
	Get the path of active dataset relative to the base_group.

std::string	get_base_path ()
	Get the path to the base group object.

void	swap (WriteTask &other)
	Swap the state of the caller with 'other'.

template<typename Basegroupbuilder , typename Writertype , typename Buildertype , typename AWritertypeG , typename AWritertypeD >
	WriteTask (Basegroupbuilder &&bgb, Writertype &&w, Buildertype &&b, AWritertypeG &&ag, AWritertypeD &&ad)
	Construct a new Write Task object.

	WriteTask ()=default
	Construct a new writer Task object.

	WriteTask (const WriteTask &other)=default

	WriteTask (WriteTask &&other)=default
	Construct a new writer Task object.

WriteTask &	operator= (const WriteTask &other)=default
	Copy assign caller from 'other'.

WriteTask &	operator= (WriteTask &&other)=default
	Move assign from 'other'.

	~WriteTask ()=default
	Destroy the writer Task object.

Public Attributes
BasegroupBuilder	build_basegroup
	Function building a base group.

std::shared_ptr< HDFGroup >	base_group
	pointer to the hdfgroup in which all produced datasets live.

std::shared_ptr< HDFDataset >	active_dataset
	pointer to the dataset which is currently active

Writer	write_data
	Callable to write data.

Builder	build_dataset
	Callable to build new dataset.

AttributeWriterDataset	write_attribute_active_dataset
	Callable to write attributes to dataset; invoked after task write.

AttributeWriterGroup	write_attribute_basegroup
	Callabel to write attributes to base group, invoked after task build.

Detailed Description

template<class BGB, class DW, class DB, class AWG, class AWD>
struct Utopia::DataIO::WriteTask< BGB, DW, DB, AWG, AWD >

Encapsulate a task for writing data to a destination. Containes a callable 'writer' responisible for writing data to a held dataset. Contains a callabel 'build_dataset' which builds or opens a dataset for writing to in a held HDFGroup. A WriteTask is bound to a group for its entire lifetime.

Template Parameters

BGB	Basegroup builder type, automatically determined
DW	Data writer type, automatically determined
DB	Dataset builder type, automatically deterimned
AWG	Group attribute writer type, automatically determined
AWD	Dataset attribute writer type, automatically determined

Member Typedef Documentation

◆ AttributeWriterDataset

template<class BGB , class DW , class DB , class AWG , class AWD >

using Utopia::DataIO::WriteTask< BGB, DW, DB, AWG, AWD >::AttributeWriterDataset = AWD

◆ AttributeWriterGroup

template<class BGB , class DW , class DB , class AWG , class AWD >

using Utopia::DataIO::WriteTask< BGB, DW, DB, AWG, AWD >::AttributeWriterGroup = AWG

◆ BasegroupBuilder

template<class BGB , class DW , class DB , class AWG , class AWD >

using Utopia::DataIO::WriteTask< BGB, DW, DB, AWG, AWD >::BasegroupBuilder = BGB

◆ Builder

template<class BGB , class DW , class DB , class AWG , class AWD >

using Utopia::DataIO::WriteTask< BGB, DW, DB, AWG, AWD >::Builder = DB

◆ Writer

template<class BGB , class DW , class DB , class AWG , class AWD >

using Utopia::DataIO::WriteTask< BGB, DW, DB, AWG, AWD >::Writer = DW

Constructor & Destructor Documentation

◆ WriteTask() [1/4]

template<class BGB , class DW , class DB , class AWG , class AWD >

template<typename Basegroupbuilder , typename Writertype , typename Buildertype , typename AWritertypeG , typename AWritertypeD >

Utopia::DataIO::WriteTask< BGB, DW, DB, AWG, AWD >::WriteTask	(	Basegroupbuilder &&	bgb,
		Writertype &&	w,
		Buildertype &&	b,
		AWritertypeG &&	ag,
		AWritertypeD &&	ad
	)

inline

Construct a new Write Task object.

Template Parameters

Basegroupbuilder	Automatically determined.
Writertype	Automatically determined.
Buildertype	Automatically determined.
AWritertypeG	Automatically determined.
AWritertypeD	Automatically determined.

Parameters

bgb	builder function for basegroup
w	writer function for wrtiing data
b	builder function for dataset
ag	group attribute writer
ad	dataset attribute writer

                                     :
        build_basegroup(bgb),
        base_group(nullptr), active_dataset(nullptr), write_data(w),
        build_dataset(b), write_attribute_active_dataset(ad),
        write_attribute_basegroup(ag)
    {
    }

◆ WriteTask() [2/4]

template<class BGB , class DW , class DB , class AWG , class AWD >

Utopia::DataIO::WriteTask< BGB, DW, DB, AWG, AWD >::WriteTask ( )

default

Construct a new writer Task object.

◆ WriteTask() [3/4]

template<class BGB , class DW , class DB , class AWG , class AWD >

Utopia::DataIO::WriteTask< BGB, DW, DB, AWG, AWD >::WriteTask ( const WriteTask< BGB, DW, DB, AWG, AWD > & other )

default

Parameters

other WriteTask object to copy from

◆ WriteTask() [4/4]

template<class BGB , class DW , class DB , class AWG , class AWD >

Utopia::DataIO::WriteTask< BGB, DW, DB, AWG, AWD >::WriteTask ( WriteTask< BGB, DW, DB, AWG, AWD > && other )

default

Construct a new writer Task object.

Parameters

other WriteTask to move from

◆ ~WriteTask()

template<class BGB , class DW , class DB , class AWG , class AWD >

Utopia::DataIO::WriteTask< BGB, DW, DB, AWG, AWD >::~WriteTask ( )

default

Destroy the writer Task object.

Member Function Documentation

◆ get_active_path()

template<class BGB , class DW , class DB , class AWG , class AWD >

std::string Utopia::DataIO::WriteTask< BGB, DW, DB, AWG, AWD >::get_active_path ( )

inline

Get the path of active dataset relative to the base_group.

Returns: std::string

    {
        if (active_dataset != nullptr)
        {
            return active_dataset->get_path();
        }
        else
        {
            return "";
        }
    }

◆ get_base_path()

template<class BGB , class DW , class DB , class AWG , class AWD >

std::string Utopia::DataIO::WriteTask< BGB, DW, DB, AWG, AWD >::get_base_path ( )

inline

Get the path to the base group object.

Returns: std::string

    {
        if (base_group != nullptr)
        {
            return base_group->get_path();
        }
        else
        {
            return "";
        }
    }

◆ operator=() [1/2]

template<class BGB , class DW , class DB , class AWG , class AWD >

WriteTask & Utopia::DataIO::WriteTask< BGB, DW, DB, AWG, AWD >::operator= ( const WriteTask< BGB, DW, DB, AWG, AWD > & other )

default

Copy assign caller from 'other'.

Parameters

other Object to assign from

Returns: WriteTask&

◆ operator=() [2/2]

template<class BGB , class DW , class DB , class AWG , class AWD >

WriteTask & Utopia::DataIO::WriteTask< BGB, DW, DB, AWG, AWD >::operator= ( WriteTask< BGB, DW, DB, AWG, AWD > && other )

default

Move assign from 'other'.

Parameters

other Object to assign from.

Returns: WriteTask&

◆ swap()

template<class BGB , class DW , class DB , class AWG , class AWD >

void Utopia::DataIO::WriteTask< BGB, DW, DB, AWG, AWD >::swap ( WriteTask< BGB, DW, DB, AWG, AWD > & other )

inline

Swap the state of the caller with 'other'.

Parameters

other Different WriteTask object

    {
        if (this == &other)
        {
            return;
        }
        else
        {
            using std::swap;
            swap(build_basegroup, other.build_basegroup);
            swap(base_group, other.base_group);
            swap(active_dataset, other.active_dataset);
            swap(write_data, other.write_data);
            swap(build_dataset, other.build_dataset);
            swap(write_attribute_active_dataset,
                 other.write_attribute_active_dataset);
            swap(write_attribute_basegroup, other.write_attribute_basegroup);
        }
    }