Syntalos::EDLGroup

Syntalos::EDLGroup

Syntalos::EDLGroup

A grouping of groups or datasets.

#include <edlstorage.h>

Inherits from Syntalos::EDLUnit

Inherited by Syntalos::EDLCollection

Public Functions

Name
EDLGroup(EDLGroup * parent =nullptr)
EDLGroup(const std::string & name, EDLGroup * parent =nullptr)
~EDLGroup()
EDLGroup(const EDLGroup & ) =delete
EDLGroup &operator=(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

Additional inherited members

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
EdlDateTimetimeCreated() const
voidsetTimeCreated(const EdlDateTime & time)
UuidcollectionId() const
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)
std::stringserializeManifest()
std::stringserializeAttributes()

Protected Functions inherited from Syntalos::EDLUnit

Name
voidsetObjectKind(const EDLUnitKind & kind)
voidsetParent(EDLUnit * parent)
voidsetDataObjects(std::optional< EDLDataFile > dataFile, const std::vector< EDLDataFile > & auxDataFiles ={})
std::expected< void, std::string >saveManifest()
std::expected< void, std::string >saveAttributes()
std::stringgeneratorId() const
voidsetGeneratorId(const std::string & idString)

Public Functions Documentation

function EDLGroup

explicit EDLGroup(
    EDLGroup * parent =nullptr
)

function EDLGroup

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

function ~EDLGroup

~EDLGroup()

function EDLGroup

EDLGroup(
    const EDLGroup & 
) =delete

function operator=

EDLGroup & operator=(
    const EDLGroup & 
) =delete

function setName

virtual std::expected< void, std::string > setName(
    const std::string & name
) override

Reimplements: Syntalos::EDLUnit::setName

function setRootPath

virtual void setRootPath(
    const fs::path & root
) override

Reimplements: Syntalos::EDLUnit::setRootPath

function setCollectionId

virtual void setCollectionId(
    const Uuid & uuid
) override

Reimplements: Syntalos::EDLUnit::setCollectionId

function children

std::vector< std::shared_ptr< EDLUnit > > children() const

function addChild

void addChild(
    const std::shared_ptr< EDLUnit > & edlObj
)

function groupByName

std::expected< std::shared_ptr< EDLGroup >, std::string > groupByName(
    const std::string & name,
    EDLCreateFlag flag =EDLCreateFlag::OPEN_ONLY
)

function datasetByName

std::expected< std::shared_ptr< EDLDataset >, std::string > datasetByName(
    const std::string & name,
    EDLCreateFlag flag =EDLCreateFlag::OPEN_ONLY
)

function save

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

Reimplements: Syntalos::EDLUnit::save

function validate

virtual std::expected< void, std::string > validate(
    bool recursive =true
) override

Reimplements: Syntalos::EDLUnit::validate


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