Syntalos::EDLUnit
Syntalos::EDLUnit
Base class for all EDL entities.
#include <edlstorage.h>
Inherited by Syntalos::EDLDataset, Syntalos::EDLGroup
Public Functions
| Name | |
|---|---|
| EDLUnit(EDLUnitKind kind, EDLUnit * parent =nullptr) | |
| virtual | ~EDLUnit() |
| EDLUnit(const EDLUnit & ) =delete | |
| EDLUnit & | operator=(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 > | save() |
| virtual std::expected< void, std::string > | validate(bool recursive =true) |
| std::string | serializeManifest() |
| std::string | serializeAttributes() |
Protected Functions
| 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
| Name | |
|---|---|
| class | EDLGroup |
Public Functions Documentation
function EDLUnit
explicit EDLUnit(
EDLUnitKind kind,
EDLUnit * parent =nullptr
)function ~EDLUnit
virtual ~EDLUnit()function EDLUnit
EDLUnit(
const EDLUnit &
) =deletefunction operator=
EDLUnit & operator=(
const EDLUnit &
) =deletefunction objectKind
EDLUnitKind objectKind() constfunction objectKindString
std::string objectKindString() constfunction parent
EDLUnit * parent() constfunction name
std::string name() constfunction setName
virtual std::expected< void, std::string > setName(
const std::string & name
)Reimplemented by: Syntalos::EDLGroup::setName
function timeCreated
EdlDateTime timeCreated() constfunction setTimeCreated
void setTimeCreated(
const EdlDateTime & time
)function collectionId
Uuid collectionId() constfunction setCollectionId
virtual void setCollectionId(
const Uuid & uuid
)Reimplemented by: Syntalos::EDLGroup::setCollectionId
function collectionShortTag
std::string collectionShortTag() constGet part of the long collection-id as a short tag in e.g. filenames.
Return: Collection ID fragment string for use as short tag
function addAuthor
void addAuthor(
const EDLAuthor & author
)function authors
std::vector< EDLAuthor > authors() constfunction path
fs::path path() constfunction setPath
void setPath(
const fs::path & path
)function rootPath
fs::path rootPath() constfunction attributes
std::map< std::string, MetaValue > attributes() constfunction setAttributes
void setAttributes(
const std::map< std::string, MetaValue > & attributes
)function insertAttribute
void insertAttribute(
const std::string & key,
const MetaValue & value
)function save
virtual std::expected< void, std::string > save()Reimplemented by: Syntalos::EDLDataset::save, Syntalos::EDLGroup::save
function validate
virtual std::expected< void, std::string > validate(
bool recursive =true
)Reimplemented by: Syntalos::EDLGroup::validate
function serializeManifest
std::string serializeManifest()function serializeAttributes
std::string serializeAttributes()Protected Functions Documentation
function setObjectKind
void setObjectKind(
const EDLUnitKind & kind
)function setParent
void setParent(
EDLUnit * parent
)function setRootPath
virtual void setRootPath(
const fs::path & root
)Reimplemented by: Syntalos::EDLGroup::setRootPath
function setDataObjects
void setDataObjects(
std::optional< EDLDataFile > dataFile,
const std::vector< EDLDataFile > & auxDataFiles ={}
)function saveManifest
std::expected< void, std::string > saveManifest()function saveAttributes
std::expected< void, std::string > saveAttributes()function generatorId
std::string generatorId() constfunction setGeneratorId
void setGeneratorId(
const std::string & idString
)Friends
friend EDLGroup
friend class EDLGroup(
EDLGroup
);Updated on 2026-04-24 at 06:25:17 +0000