Syntalos::EDLCollection

Syntalos::EDLCollection

Syntalos::EDLCollection

A collection of groups and datasets.

#include <edlstorage.h>

Inherits from Syntalos::EDLGroup, Syntalos::EDLUnit

Public Functions

Name
EDLCollection(const std::string & name ={})
~EDLCollection()
EDLCollection(const EDLCollection & ) =delete
EDLCollection &operator=(const EDLCollection & ) =delete
std::stringgeneratorId() const
voidsetGeneratorId(const std::string & idString)

Additional inherited members

Public Functions inherited from Syntalos::EDLGroup

Name
EDLGroup(EDLGroup * parent =nullptr)
EDLGroup(const std::string & name, EDLGroup * parent =nullptr)
~EDLGroup()
EDLGroup(const EDLGroup & ) =delete
virtual std::expected< void, std::string >setName(const std::string & name) override
virtual voidsetRootPath(const fs::path & root) override
virtual voidsetCollectionId(const Uuid & uuid) override
std::vector< std::shared_ptr< EDLUnit > >children() const
voidaddChild(const std::shared_ptr< EDLUnit > & edlObj)
std::expected< std::shared_ptr< EDLGroup >, std::string >groupByName(const std::string & name, EDLCreateFlag flag =EDLCreateFlag::OPEN_ONLY)
std::expected< std::shared_ptr< EDLDataset >, std::string >datasetByName(const std::string & name, EDLCreateFlag flag =EDLCreateFlag::OPEN_ONLY)
virtual std::expected< void, std::string >save() override
virtual std::expected< void, std::string >validate(bool recursive =true) override

Public Functions inherited from Syntalos::EDLUnit

Name
EDLUnit(EDLUnitKind kind, EDLUnit * parent =nullptr)
virtual~EDLUnit()
EDLUnit(const EDLUnit & ) =delete
EDLUnitKindobjectKind() const
std::stringobjectKindString() const
EDLUnit *parent() const
std::stringname() const
virtual std::expected< void, std::string >setName(const std::string & name)
EdlDateTimetimeCreated() const
voidsetTimeCreated(const EdlDateTime & time)
UuidcollectionId() const
virtual voidsetCollectionId(const Uuid & uuid)
std::stringcollectionShortTag() const
Get part of the long collection-id as a short tag in e.g. filenames.
voidaddAuthor(const EDLAuthor & author)
std::vector< EDLAuthor >authors() const
fs::pathpath() const
voidsetPath(const fs::path & path)
fs::pathrootPath() const
std::map< std::string, MetaValue >attributes() const
voidsetAttributes(const std::map< std::string, MetaValue > & attributes)
voidinsertAttribute(const std::string & key, const MetaValue & value)
virtual std::expected< void, std::string >save()
virtual std::expected< void, std::string >validate(bool recursive =true)
std::stringserializeManifest()
std::stringserializeAttributes()

Protected Functions inherited from Syntalos::EDLUnit

Name
voidsetObjectKind(const EDLUnitKind & kind)
voidsetParent(EDLUnit * parent)
virtual voidsetRootPath(const fs::path & root)
voidsetDataObjects(std::optional< EDLDataFile > dataFile, const std::vector< EDLDataFile > & auxDataFiles ={})
std::expected< void, std::string >saveManifest()
std::expected< void, std::string >saveAttributes()

Friends inherited from Syntalos::EDLUnit

Name
classEDLGroup

Public Functions Documentation

function EDLCollection

explicit EDLCollection(
    const std::string & name ={}
)

function ~EDLCollection

~EDLCollection()

function EDLCollection

EDLCollection(
    const EDLCollection & 
) =delete

function operator=

EDLCollection & operator=(
    const EDLCollection & 
) =delete

function generatorId

std::string generatorId() const

function setGeneratorId

void setGeneratorId(
    const std::string & idString
)

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