Syntalos::EDLUnit

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
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

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()
std::stringgeneratorId() const
voidsetGeneratorId(const std::string & idString)

Friends

Name
classEDLGroup

Public Functions Documentation

function EDLUnit

explicit EDLUnit(
    EDLUnitKind kind,
    EDLUnit * parent =nullptr
)

function ~EDLUnit

virtual ~EDLUnit()

function EDLUnit

EDLUnit(
    const EDLUnit & 
) =delete

function operator=

EDLUnit & operator=(
    const EDLUnit & 
) =delete

function objectKind

EDLUnitKind objectKind() const

function objectKindString

std::string objectKindString() const

function parent

EDLUnit * parent() const

function name

std::string name() const

function setName

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

Reimplemented by: Syntalos::EDLGroup::setName

function timeCreated

EdlDateTime timeCreated() const

function setTimeCreated

void setTimeCreated(
    const EdlDateTime & time
)

function collectionId

Uuid collectionId() const

function setCollectionId

virtual void setCollectionId(
    const Uuid & uuid
)

Reimplemented by: Syntalos::EDLGroup::setCollectionId

function collectionShortTag

std::string collectionShortTag() const

Get 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() const

function path

fs::path path() const

function setPath

void setPath(
    const fs::path & path
)

function rootPath

fs::path rootPath() const

function attributes

std::map< std::string, MetaValue > attributes() const

function 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() const

function setGeneratorId

void setGeneratorId(
    const std::string & idString
)

Friends

friend EDLGroup

friend class EDLGroup(
    EDLGroup 
);

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