![]() |
Face Engine SDK
5.9.0
A face detection, recognition and tracking engine.
|
SDK settings provider interface. More...
#include <ISettingsProvider.h>
Classes | |
| struct | Desc |
| Configuration parameter description. More... | |
| struct | Entry |
| Configuration parameter entry. More... | |
| struct | Key |
| Configuration parameter key. More... | |
| struct | Value |
| Configuration parameter value. More... | |
Public Types | |
| enum | Error : uint32_t { Error::Ok, Error::IOError, Error::Memory, Error::Internal, Error::InvalidPi, Error::InvalidTag, Error::InvalidCdata, Error::FileNotFound, Error::InvalidPcdata, Error::InvalidDocType, Error::InvalidSettings, Error::InvalidComment, Error::InvalidAttribute, Error::InvalidEndElement, Error::AppendInvalidRoot, Error::NoDocumentElement, Error::EndElementMismatch, Error::InvalidStartElement, Error::MemoryAllocationFailed } |
| Config parsing error codes. More... | |
Public Member Functions | |
| virtual const char * | getDefaultPath () const noexcept=0 |
| Get settings path this provider is bound to. More... | |
| virtual void | setDefaultPath (const char *path) noexcept=0 |
| Sets default path for saving of settings provider. More... | |
| virtual Result< Error > | load (const char *path) noexcept=0 |
| Load settings from given path. More... | |
| virtual Result< Error > | loadFromString (const char *content) noexcept=0 |
| Load settings from given xml-formatted string. More... | |
| virtual bool | save (const char *path) const noexcept=0 |
| Save settings values using the default path. More... | |
| virtual void | clear () noexcept=0 |
| Clear settings. More... | |
| virtual bool | isEmpty () const noexcept=0 |
| virtual void | setDesc (const Key &key, const Desc &desc) noexcept=0 |
| Set parameter description. More... | |
| void | setDesc (const char *section, const char *parameter, const Desc &desc) noexcept |
| Set parameter description. More... | |
| virtual void | setValue (const Key &key, Value &&value) noexcept=0 |
| Set parameter value. More... | |
| void | setValue (const char *section, const char *parameter, Value &&value) noexcept |
| Set parameter value. More... | |
| virtual void | setEntry (const Key &key, Entry &&entry) noexcept=0 |
| Set parameter. More... | |
| void | setEntry (const Key &key, const Desc &desc, Value &&value) noexcept |
| Set parameter. More... | |
| void | setEntry (const char *section, const char *parameter, const Desc &desc, Value &&value) noexcept |
| Set parameter. More... | |
| virtual const Entry & | getEntry (const Key &key) const noexcept=0 |
| Find parameter entry. More... | |
| Desc | getDesc (const Key &key) const noexcept |
| Get parameter description. More... | |
| Desc | getDesc (const char *section, const char *parameter) const noexcept |
| Get parameter description. More... | |
| const Value & | getValue (const Key &key) const noexcept |
| Get parameter value. More... | |
| const Value & | getValue (const char *section, const char *parameter) const noexcept |
| Get parameter value. More... | |
Public Member Functions inherited from fsdk::IRefCounted | |
| virtual int32_t | retain () noexcept=0 |
| Increase strong reference count. More... | |
| virtual int32_t | retainLocked () noexcept=0 |
| Increase strong reference count thread safely. More... | |
| virtual int32_t | release () noexcept=0 |
| Decrease strong reference count. More... | |
| virtual int32_t | getRefCount () const noexcept=0 |
| Get actual strong reference count. More... | |
| virtual int32_t | retainWeak () noexcept=0 |
| Increase weak reference count. More... | |
| virtual int32_t | releaseWeak () noexcept=0 |
| Decrease weak reference count. More... | |
| virtual int32_t | getWeakRefCount () const noexcept=0 |
| Get actual weak reference count. More... | |
SDK settings provider interface.
Takes care of loading and parsing of SDK configuration files.
|
strong |
Config parsing error codes.
|
pure virtualnoexcept |
Clear settings.
|
pure virtualnoexcept |
Get settings path this provider is bound to.
This is the same path that was given to load().
|
noexcept |
Get parameter description.
Lookup parameter by key. Return empty description if the parameters does not exist.
| section | parameter section. |
| parameter | parameter name. |
Get parameter description.
Lookup parameter by key. Return empty description if the parameters does not exist.
| key | parameter key. |
|
pure virtualnoexcept |
Find parameter entry.
Lookup parameter by key. Return empty entry if the parameters does not exist.
| key | parameter key. |
|
noexcept |
Get parameter value.
Lookup parameter by key. Return empty value if the parameters does not exist.
| section | parameter section. |
| parameter | parameter name. |
Get parameter value.
Lookup parameter by key. Return empty value if the parameters does not exist.
| key | parameter key. |
|
pure virtualnoexcept |
Check if there are loaded settings.
|
pure virtualnoexcept |
Save settings values using the default path.
path may be null, in this case a path from getDefaultPath() will be used.
|
pure virtualnoexcept |
Sets default path for saving of settings provider.
| path | default path |
|
noexcept |
Set parameter description.
Lookup parameter by key. Creates a parameter if it does not already exist.
| section | parameter section. |
| parameter | parameter name. |
| desc | parameter description. |
|
pure virtualnoexcept |
Set parameter description.
Lookup parameter by key. Creates a parameter if it does not already exist.
| key | parameter key. |
| desc | parameter description. |
|
noexcept |
Set parameter.
Lookup parameter by key. Creates a parameter if it does not already exist.
| section | parameter section. |
| parameter | parameter name. |
| desc | parameter description. |
| value | parameter value. |
|
noexcept |
Set parameter.
Lookup parameter by key. Creates a parameter if it does not already exist.
| key | parameter key. |
| desc | parameter description. |
| value | parameter value. |
|
pure virtualnoexcept |
Set parameter.
Lookup parameter by key. Creates a parameter if it does not already exist.
| key | parameter key. |
| entry | parameter entry. |
|
noexcept |
Set parameter value.
Lookup parameter by key. Creates a parameter if it does not already exist.
| section | parameter section. |
| parameter | parameter name. |
| value | parameter value. |
|
pure virtualnoexcept |
Set parameter value.
Lookup parameter by key. Creates a parameter if it does not already exist.
| key | parameter key. |
| value | parameter value. |