| Face Engine SDK 5.2.0 A face detection, recognition and tracking engine.

- Main Page
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions | List of all members
fsdk::IIndexBuilder Struct Referenceabstract

Index builder interface. More...

`#include <IIndex.h>`

Inheritance diagram for fsdk::IIndexBuilder:

## Public Member Functions
virtual ResultValue< FSDKError, IDynamicIndex * > | buildIndex (const IProgressTracker *const progressTracker=nullptr) noexcept=0
| Builds index with every descriptor appended. Blocks until completed. More...
virtual ResultValue< FSDKError, Future< ResultValue< FSDKError, IDynamicIndex * > > > | buildIndexAsync (IAsyncContext *const asyncContext, const IProgressTracker *const progressTracker=nullptr) noexcept=0
| Builds index with every descriptor appended. Non blocking operation. More...
Public Member Functions inherited from fsdk::IDynamicDescriptorStorage
virtual ResultValue< FSDKError, DescriptorId > | appendDescriptor (const IDescriptor *desciptor) noexcept=0
| Appends descriptor to internal storage. If used on. More...
virtual ResultValue< FSDKError, DescriptorId > | appendBatch (const IDescriptorBatch *batch) noexcept=0
| Appends batch of descriptors to internal storage. If used on. More...
virtual Result< FSDKError > | removeDescriptor (const DescriptorId index) noexcept=0
| Removes descriptor out of internal storage. If used on. More...
Public Member Functions inherited from fsdk::IStaticDescriptorStorage
virtual Result< FSDKError > | descriptorByIndex (const DescriptorId index, IDescriptor *descriptor) const noexcept=0
| Requests descriptor data out of internal storage. More...
virtual uint32_t | getDescriptorVersion () const noexcept=0
| Return version of stored descriptors. More...
virtual uint64_t | size () const noexcept=0
| Return size of internal storage. More...
Public Member Functions inherited from fsdk::IRefCounted
virtual int32_t | retain () noexcept=0
| Increase strong reference count. 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...

## Detailed Description

Index builder interface.

## Member Function Documentation

virtual ResultValue<FSDKError, IDynamicIndex*> fsdk::IIndexBuilder::buildIndex | ( | const IProgressTracker *const | progressTracker = `nullptr` | ) |
| pure virtual noexcept

Builds index with every descriptor appended. Blocks until completed.

Is very heavy method in terms of computing load.

Parameters

  progressTracker | Some object that is being reported to with progress. If its nullptr, dont report progress.

Returns
  One of the error codes specified by

See Also
  FSDKError and created index object.

virtual ResultValue<FSDKError, Future<ResultValue<FSDKError, IDynamicIndex*> > > fsdk::IIndexBuilder::buildIndexAsync | ( | IAsyncContext *const | asyncContext,
|  | const IProgressTracker *const | progressTracker = `nullptr`
| ) |  |
| pure virtual noexcept

Builds index with every descriptor appended. Non blocking operation.

Is very heavy method in terms of computing load.

Parameters

  asyncContext | Asynchronous context to run build on.
  progressTracker | Some object that is being reported to with progress. If its nullptr, dont report progress.

Returns
  One of the error codes specified by

See Also
  FSDKError and created index object.

The documentation for this struct was generated from the following file:

- include/fsdk/IIndex.h