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 ={}, const Uuid & uuid ={}) | |
| ~EDLCollection() override | |
| EDLCollection(const EDLCollection & ) =delete | |
| EDLCollection & | operator=(const EDLCollection & ) =delete |
| virtual std::string | generatorId() const override |
| virtual void | setGeneratorId(const std::string & idString) override |
| std::string | collectionMoniker() const |
| void | setCollectionHasMoniker(bool useMoniker) |
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 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 |
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) |
| bool | isDetached() const |
| void | setDetached(bool detached) |
| virtual std::expected< void, std::string > | save() |
| 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() |
| void | setCollectionMoniker(const std::string & moniker) |
Friends inherited from Syntalos::EDLUnit
| Name | |
|---|---|
| class | EDLGroup |
Public Functions Documentation
function EDLCollection
explicit EDLCollection(
const std::string & name ={},
const Uuid & uuid ={}
)function ~EDLCollection
~EDLCollection() overridefunction EDLCollection
EDLCollection(
const EDLCollection &
) =deletefunction operator=
EDLCollection & operator=(
const EDLCollection &
) =deletefunction generatorId
virtual std::string generatorId() const overrideReimplements: Syntalos::EDLUnit::generatorId
function setGeneratorId
virtual void setGeneratorId(
const std::string & idString
) overrideReimplements: Syntalos::EDLUnit::setGeneratorId
function collectionMoniker
std::string collectionMoniker() constfunction setCollectionHasMoniker
void setCollectionHasMoniker(
bool useMoniker
)Updated on 2026-05-15 at 01:05:43 +0000