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 void | setRootPath(const fs::path & root) override |
| virtual void | setCollectionId(const Uuid & uuid) override |
| std::vector< std::shared_ptr< EDLUnit > > | children() const |
| void | addChild(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 | |
| EDLUnitKind | objectKind() const |
| std::string | objectKindString() const |
| EDLUnit * | parent() const |
| std::string | name() const |
| EdlDateTime | timeCreated() const |
| void | setTimeCreated(const EdlDateTime & time) |
| Uuid | collectionId() const |
| 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) |
| std::string | serializeManifest() |
| std::string | serializeAttributes() |
Protected Functions inherited from Syntalos::EDLUnit
| Name | |
|---|---|
| void | setObjectKind(const EDLUnitKind & kind) |
| void | setParent(EDLUnit * parent) |
| 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) |
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 &
) =deletefunction operator=
EDLGroup & operator=(
const EDLGroup &
) =deletefunction setName
virtual std::expected< void, std::string > setName(
const std::string & name
) overrideReimplements: Syntalos::EDLUnit::setName
function setRootPath
virtual void setRootPath(
const fs::path & root
) overrideReimplements: Syntalos::EDLUnit::setRootPath
function setCollectionId
virtual void setCollectionId(
const Uuid & uuid
) overrideReimplements: Syntalos::EDLUnit::setCollectionId
function children
std::vector< std::shared_ptr< EDLUnit > > children() constfunction 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() overrideReimplements: Syntalos::EDLUnit::save
function validate
virtual std::expected< void, std::string > validate(
bool recursive =true
) overrideReimplements: Syntalos::EDLUnit::validate
Updated on 2026-04-24 at 06:25:17 +0000