fsdk::IDescriptor Struct Reference

Descriptor interface. More...

#include <IDescriptor.h>

Inheritance diagram for fsdk::IDescriptor:

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.
Public Member Functions inherited from fsdk::IDataStorageObject
virtual void	clear () noexcept=0
	Clear object data.
virtual IRefCounted *	getParentObject () const noexcept=0
	Get parent object (one that has created this).
Public Member Functions inherited from fsdk::ISerializableObject
virtual void	getSize (Sizer &sizer, uint32_t flags=Default) const noexcept=0
	Estimate size of this object binary data.
virtual Result< Error >	load (IArchive *archive, uint32_t flags=Default)=0
	Load object from archive.
virtual Result< Error >	save (IArchive *archive, uint32_t flags=Default) const =0
	Save object to archive.
Public Member Functions inherited from fsdk::IRefCounted
virtual int32_t	retain () noexcept=0
	Increase strong reference count.
virtual int32_t	retainLocked () noexcept=0
	Increase strong reference count thread safely.
virtual int32_t	release () noexcept=0
	Decrease strong reference count.
virtual int32_t	getRefCount () const noexcept=0
	Get actual strong reference count.
virtual int32_t	retainWeak () noexcept=0
	Increase weak reference count.
virtual int32_t	releaseWeak () noexcept=0
	Decrease weak reference count.
virtual int32_t	getWeakRefCount () const noexcept=0
	Get actual weak reference count.

Additional Inherited Members
Public Types inherited from fsdk::ISerializableObject
enum class	Error : uint32_t {   Ok , Size , Signature , ArchiveRead ,   InputArchive , ArchiveWrite }
	Serialization nerror codes. More...
enum	Flags { Default = 0 , NoSignature = 1 }
	Serialization flags. More...

Detailed Description

Descriptor interface.

Used for matching.

Member Function Documentation

getDescriptor()

virtual bool fsdk::IDescriptor::getDescriptor ( uint8_t * buffer ) const

pure virtualnoexcept

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.

getDescriptorLength()

virtual uint32_t fsdk::IDescriptor::getDescriptorLength ( ) const

pure virtualnoexcept

return size of descriptor in bytes.

Returns

size of descriptor in bytes.

Note

This method is thread safe.

getDescriptorType()

virtual DescriptorType fsdk::IDescriptor::getDescriptorType ( ) const

pure virtualnoexcept

Get type of descriptor.

Returns

type as enum.

See also

DescriptorType for details.

getModelVersion()

virtual uint32_t fsdk::IDescriptor::getModelVersion ( ) const

pure virtualnoexcept

Get algorithm model version this descriptor was created with.

Returns

Version as integral number.

setDescriptor()

virtual void fsdk::IDescriptor::setDescriptor ( const uint8_t * buffer )

pure virtualnoexcept

Copy descriptor from user providedbuffer.

Parameters

[in]

buffer

user provided buffer.

---

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

• fsdk.framework/Headers/IDescriptor.h