fsdk::IDescriptor Struct Reference

Descriptor interface. More...

#include <IDescriptor.h>

Inheritance diagram for fsdk::IDescriptor:

List of all members.

Public Member Functions
virtual uint32_t	getModelVersion () const noexcept=0
	Get algorithm model version this descriptor was created with.
virtual DescriptorType	getDescriptorType () const noexcept=0
	Get type of descriptor.
virtual uint32_t	getDescriptorLength () const noexcept=0
	return size of descriptor in bytes.
virtual bool	getDescriptor (uint8_t *buffer) const noexcept=0
	Copy descriptor data to user provided buffer.
virtual void	setDescriptor (const uint8_t *buffer) noexcept=0
	Copy descriptor from user providedbuffer.

---

Detailed Description

Descriptor interface.

Used for matching.

---

Member Function Documentation

virtual bool fsdk::IDescriptor::getDescriptor

(

uint8_t *

buffer

)

const [pure virtual]

Copy descriptor data to user provided buffer.

Parameters:

[out]

buffer

user provided buffer.

Returns:

true if OK, and false if ERROR.

Note:

This method is thread safe.

buffer must be preallocated by client code.

virtual uint32_t fsdk::IDescriptor::getDescriptorLength

(

)

const [pure virtual]

return size of descriptor in bytes.

Returns:

size of descriptor in bytes.

Note:

This method is thread safe.

virtual DescriptorType fsdk::IDescriptor::getDescriptorType

(

)

const [pure virtual]

Get type of descriptor.

Returns:

type as enum.

See also:

DescriptorType for details.

virtual uint32_t fsdk::IDescriptor::getModelVersion

(

)

const [pure virtual]

Get algorithm model version this descriptor was created with.

Returns:

Version as integral number.

virtual void fsdk::IDescriptor::setDescriptor

(

const uint8_t *

buffer

)

[pure virtual]

Copy descriptor from user providedbuffer.

Parameters:

[in]

buffer

user provided buffer.

---

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

• include/fsdk/IDescriptor.h