Syntalos::EDLDataset

An EDL dataset. More…

#include <edlstorage.h>

Public Functions

	Name
	EDLDataset(EDLGroup * parent =nullptr)
	EDLDataset(const std::string & name, EDLGroup * parent =nullptr)
	~EDLDataset()
	EDLDataset(const EDLDataset & ) =delete
EDLDataset &	operator=(const EDLDataset & ) =delete
virtual std::expected< void, std::string >	save() override
bool	isEmpty() const
fs::path	setDataFile(const std::string & fname, const std::string & summary ={})
fs::path	addDataFilePart(const std::string & fname, int index =-1)
EDLDataFile	dataFile() const
std::expected< fs::path, std::string >	addAuxDataFile(const std::string & fname, const std::string & key ={}, const std::string & summary ={})
std::expected< fs::path, std::string >	addAuxDataFilePart(const std::string & fname, const std::string & key ={}, int index =-1)
void	setDataScanPattern(const std::string & wildcard, const std::string & summary ={}) Set a pattern to find data files.
void	addAuxDataScanPattern(const std::string & wildcard, const std::string & summary ={})
fs::path	pathForDataBasename(const std::string & baseName) Get absolute path for data with a given basename Retrieve an absolute path for the given basename in this dataset. The data is not registered with the dataset, to add it properly, you need to register a scan pattern. The use of this pattern is discouraged, try to add new data explicitly rather then implicitly.
fs::path	pathForDataPart(const EDLDataPart & dpart) Return absolute path to data file on disk. This function will just return the absolute path of the given data part on disk. If the data part passed as parameter does not belong to this dataset, an invalid part will be returned. The function will not check for existence of the file!

Additional inherited members

Public Functions inherited from Syntalos::EDLUnit

	Name
	EDLUnit(EDLUnitKind kind, EDLUnit * parent =nullptr)
virtual	~EDLUnit()
	EDLUnit(const EDLUnit & ) =delete
EDLUnitKind	objectKind() const
std::string	objectKindString() const
EDLUnit *	parent() const
std::string	name() const
virtual std::expected< void, std::string >	setName(const std::string & name)
EdlDateTime	timeCreated() const
void	setTimeCreated(const EdlDateTime & time)
Uuid	collectionId() const
virtual void	setCollectionId(const Uuid & uuid)
std::string	collectionShortTag() const Get part of the long collection-id as a short tag in e.g. filenames.
void	addAuthor(const EDLAuthor & author)
std::vector< EDLAuthor >	authors() const
fs::path	path() const
void	setPath(const fs::path & path)
fs::path	rootPath() const
std::map< std::string, MetaValue >	attributes() const
void	setAttributes(const std::map< std::string, MetaValue > & attributes)
void	insertAttribute(const std::string & key, const MetaValue & value)
virtual std::expected< void, std::string >	validate(bool recursive =true)
std::string	serializeManifest()
std::string	serializeAttributes()

Protected Functions inherited from Syntalos::EDLUnit

	Name
void	setObjectKind(const EDLUnitKind & kind)
void	setParent(EDLUnit * parent)
virtual void	setRootPath(const fs::path & root)
void	setDataObjects(std::optional< EDLDataFile > dataFile, const std::vector< EDLDataFile > & auxDataFiles ={})
std::expected< void, std::string >	saveManifest()
std::expected< void, std::string >	saveAttributes()
std::string	generatorId() const
void	setGeneratorId(const std::string & idString)

Friends inherited from Syntalos::EDLUnit

	Name
class	EDLGroup

Detailed Description

class Syntalos::EDLDataset;

An EDL dataset.

A set of data files which belongs together (usually data of the same modality from the same source)

Public Functions Documentation

function EDLDataset

explicit EDLDataset(
    EDLGroup * parent =nullptr
)

function EDLDataset

EDLDataset(
    const std::string & name,
    EDLGroup * parent =nullptr
)

function ~EDLDataset

~EDLDataset()

function EDLDataset

EDLDataset(
    const EDLDataset & 
) =delete

function operator=

EDLDataset & operator=(
    const EDLDataset & 
) =delete

function save

virtual std::expected< void, std::string > save() override

Reimplements: Syntalos::EDLUnit::save

function isEmpty

bool isEmpty() const

function setDataFile

fs::path setDataFile(
    const std::string & fname,
    const std::string & summary ={}
)

function addDataFilePart

fs::path addDataFilePart(
    const std::string & fname,
    int index =-1
)

function dataFile

EDLDataFile dataFile() const

function addAuxDataFile

std::expected< fs::path, std::string > addAuxDataFile(
    const std::string & fname,
    const std::string & key ={},
    const std::string & summary ={}
)

function addAuxDataFilePart

std::expected< fs::path, std::string > addAuxDataFilePart(
    const std::string & fname,
    const std::string & key ={},
    int index =-1
)

function setDataScanPattern

void setDataScanPattern(
    const std::string & wildcard,
    const std::string & summary ={}
)

Set a pattern to find data files.

Parameters:

wildcard Wildcard to find generated data

Set a pattern to find generated data when the dataset object is saved, if the data was generated externally and could not be registered properly with addDataPartFilename().

function addAuxDataScanPattern

void addAuxDataScanPattern(
    const std::string & wildcard,
    const std::string & summary ={}
)

function pathForDataBasename

fs::path pathForDataBasename(
    const std::string & baseName
)

Get absolute path for data with a given basename Retrieve an absolute path for the given basename in this dataset. The data is not registered with the dataset, to add it properly, you need to register a scan pattern. The use of this pattern is discouraged, try to add new data explicitly rather then implicitly.

This function ensures the path to the selected data exists, but the data file itself may not be present on disk. An empty path may be returned in case no path could be created.

function pathForDataPart

fs::path pathForDataPart(
    const EDLDataPart & dpart
)

Return absolute path to data file on disk. This function will just return the absolute path of the given data part on disk. If the data part passed as parameter does not belong to this dataset, an invalid part will be returned. The function will not check for existence of the file!

Parameters:

dpart The data part to resolve

Return: Absolute filepath

Updated on 2026-04-24 at 06:25:17 +0000

Syntalos::EDLDataPart Syntalos::EDLGroup