Skip to content

cvedia::rt::iface::CVDictRoot

Inherited by CVDictRootImpl

Public Functions

Name
virtual ~CVDictRoot() =default
virtual NODISCARD expected< void > loadJsonFromDisk(std::string const & jsonFile) =0
virtual NODISCARD expected< void > loadFromJsonString(std::string const & jsonString) =0
virtual NODISCARD expected< void > saveToDiskAsJson(std::string const & path) const =0
virtual NODISCARD std::string asJsonString(int indent =0) const =0
virtual NODISCARD pCValue getCopyOfNode() const =0
virtual NODISCARD pCValue getCopyOfNode(std::string const & nodePath) const =0
virtual NODISCARD expected< pCValue > getCopyOfNodeIfSet(std::string const & nodePath) const =0
virtual NODISCARD pCValue getNodeUnsafe() const =0
virtual NODISCARD pCValue getNodeUnsafe(std::string const & nodePath) const =0
virtual NODISCARD expected< pCValue > getNodeIfSetUnsafe(std::string const & nodePath) const =0
virtual NODISCARD bool isNodeSet(std::string const & nodePath) const =0
virtual expected< void > setNode(std::string const & nodePath, CValue const & cval) =0
virtual bool deleteNode(std::string const & nodePath) =0
virtual void merge(pCValue const & other, bool refSourceIsSelf) =0
virtual NODISCARD expected< void > mergeAt(std::string const & path, pCValue const & other, bool refSourceIsSelf) =0
virtual void override(pCValue const & other) =0
virtual NODISCARD expected< void > overrideAt(std::string const & path, pCValue const & other) =0
virtual NODISCARD std::vector< std::string > getKeys() const =0
virtual bool setValue(std::string const & path, bool x) =0
virtual bool setValue(std::string const & path, int x) =0
virtual bool setValue(std::string const & path, float x) =0
virtual bool setValue(std::string const & path, double x) =0
virtual bool setValue(std::string const & path, std::string const & x) =0
virtual bool setValue(std::string const & path, char *const & x) =0
virtual bool setValue(std::string const & path, Rect2f const & x) =0
virtual bool setValue(std::string const & path, cbuffer const & x) =0
virtual bool setValue(std::string const & path, std::vector< float > const & x) =0
virtual bool setValue(std::string const & path, CValue const & x) =0
virtual bool setValue(std::string const & path, cvec const & x) =0
virtual bool setValue(std::string const & path, cmap const & x) =0
virtual NODISCARD std::shared_lock< shared_mutex_class > getReadLock() const =0
virtual NODISCARD std::unique_lock< shared_mutex_class > getWriteLock() const =0
virtual NODISCARD std::shared_lock< shared_mutex_class > getReadLockAdopt() const =0
virtual NODISCARD std::unique_lock< shared_mutex_class > getWriteLockAdopt() const =0
virtual NODISCARD std::shared_lock< shared_mutex_class > getReadLockDefer() const =0
virtual NODISCARD std::unique_lock< shared_mutex_class > getWriteLockDefer() const =0
virtual NODISCARD shared_mutex_class & getMutex() const =0

Public Functions Documentation

function ~CVDictRoot

virtual ~CVDictRoot() =default

function loadJsonFromDisk

virtual NODISCARD expected< void > loadJsonFromDisk(
    std::string const & jsonFile
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::loadJsonFromDisk

function loadFromJsonString

virtual NODISCARD expected< void > loadFromJsonString(
    std::string const & jsonString
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::loadFromJsonString

function saveToDiskAsJson

virtual NODISCARD expected< void > saveToDiskAsJson(
    std::string const & path
) const =0

Reimplemented by: cvedia::rt::CVDictRootImpl::saveToDiskAsJson

function asJsonString

virtual NODISCARD std::string asJsonString(
    int indent =0
) const =0

Reimplemented by: cvedia::rt::CVDictRootImpl::asJsonString

function getCopyOfNode

virtual NODISCARD pCValue getCopyOfNode() const =0

Reimplemented by: cvedia::rt::CVDictRootImpl::getCopyOfNode

function getCopyOfNode

virtual NODISCARD pCValue getCopyOfNode(
    std::string const & nodePath
) const =0

Reimplemented by: cvedia::rt::CVDictRootImpl::getCopyOfNode

function getCopyOfNodeIfSet

virtual NODISCARD expected< pCValue > getCopyOfNodeIfSet(
    std::string const & nodePath
) const =0

Reimplemented by: cvedia::rt::CVDictRootImpl::getCopyOfNodeIfSet

function getNodeUnsafe

virtual NODISCARD pCValue getNodeUnsafe() const =0

Reimplemented by: cvedia::rt::CVDictRootImpl::getNodeUnsafe

function getNodeUnsafe

virtual NODISCARD pCValue getNodeUnsafe(
    std::string const & nodePath
) const =0

Reimplemented by: cvedia::rt::CVDictRootImpl::getNodeUnsafe

function getNodeIfSetUnsafe

virtual NODISCARD expected< pCValue > getNodeIfSetUnsafe(
    std::string const & nodePath
) const =0

Reimplemented by: cvedia::rt::CVDictRootImpl::getNodeIfSetUnsafe

function isNodeSet

virtual NODISCARD bool isNodeSet(
    std::string const & nodePath
) const =0

Reimplemented by: cvedia::rt::CVDictRootImpl::isNodeSet

function setNode

virtual expected< void > setNode(
    std::string const & nodePath,
    CValue const & cval
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::setNode

function deleteNode

virtual bool deleteNode(
    std::string const & nodePath
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::deleteNode

function merge

virtual void merge(
    pCValue const & other,
    bool refSourceIsSelf
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::merge

function mergeAt

virtual NODISCARD expected< void > mergeAt(
    std::string const & path,
    pCValue const & other,
    bool refSourceIsSelf
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::mergeAt

function override

virtual void override(
    pCValue const & other
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::override

function overrideAt

virtual NODISCARD expected< void > overrideAt(
    std::string const & path,
    pCValue const & other
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::overrideAt

function getKeys

virtual NODISCARD std::vector< std::string > getKeys() const =0

Reimplemented by: cvedia::rt::CVDictRootImpl::getKeys

function setValue

virtual bool setValue(
    std::string const & path,
    bool x
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::setValue

function setValue

virtual bool setValue(
    std::string const & path,
    int x
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::setValue

function setValue

virtual bool setValue(
    std::string const & path,
    float x
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::setValue

function setValue

virtual bool setValue(
    std::string const & path,
    double x
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::setValue

function setValue

virtual bool setValue(
    std::string const & path,
    std::string const & x
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::setValue

function setValue

virtual bool setValue(
    std::string const & path,
    char *const & x
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::setValue

function setValue

virtual bool setValue(
    std::string const & path,
    Rect2f const & x
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::setValue

function setValue

virtual bool setValue(
    std::string const & path,
    cbuffer const & x
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::setValue

function setValue

virtual bool setValue(
    std::string const & path,
    std::vector< float > const & x
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::setValue

function setValue

virtual bool setValue(
    std::string const & path,
    CValue const & x
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::setValue

function setValue

virtual bool setValue(
    std::string const & path,
    cvec const & x
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::setValue

function setValue

virtual bool setValue(
    std::string const & path,
    cmap const & x
) =0

Reimplemented by: cvedia::rt::CVDictRootImpl::setValue

function getReadLock

virtual NODISCARD std::shared_lock< shared_mutex_class > getReadLock() const =0

Reimplemented by: cvedia::rt::CVDictRootImpl::getReadLock

function getWriteLock

virtual NODISCARD std::unique_lock< shared_mutex_class > getWriteLock() const =0

Reimplemented by: cvedia::rt::CVDictRootImpl::getWriteLock

function getReadLockAdopt

virtual NODISCARD std::shared_lock< shared_mutex_class > getReadLockAdopt() const =0

Reimplemented by: cvedia::rt::CVDictRootImpl::getReadLockAdopt

function getWriteLockAdopt

virtual NODISCARD std::unique_lock< shared_mutex_class > getWriteLockAdopt() const =0

Reimplemented by: cvedia::rt::CVDictRootImpl::getWriteLockAdopt

function getReadLockDefer

virtual NODISCARD std::shared_lock< shared_mutex_class > getReadLockDefer() const =0

Reimplemented by: cvedia::rt::CVDictRootImpl::getReadLockDefer

function getWriteLockDefer

virtual NODISCARD std::unique_lock< shared_mutex_class > getWriteLockDefer() const =0

Reimplemented by: cvedia::rt::CVDictRootImpl::getWriteLockDefer

function getMutex

virtual NODISCARD shared_mutex_class & getMutex() const =0

Reimplemented by: cvedia::rt::CVDictRootImpl::getMutex