ModalitiesGalleryConfig Class Reference

ModalitiesGallery configuration. More...

#include <ModalitiesGallery.h>

Collaboration diagram for ModalitiesGalleryConfig:

Public Member Functions
void	SetThreadsCount (unsigned int value)
	Set number of threads used by gallery.
unsigned int	GetThreadCount () const
	Get number of processing threads.
void	SetGalleryType (ModalitiesGalleryType value)
	Set type of Modalities Gallery.
ModalitiesGalleryType	GetGalleryType () const
	Get type of Modalities Gallery.
void	WriteTo (Writer &writer) const final
	Function serializes configuration via provided Writer.
IndexedModalitiesGalleryConfig	ToIndexedModalitiesGalleryConfig () const
	Function converts configuration to IndexedModalitiesGalleryConfig.
	ModalitiesGalleryConfig ()=default
	Default configuration is.

Detailed Description

ModalitiesGallery configuration.

Constructor & Destructor Documentation

ModalitiesGalleryConfig()

ModalitiesGalleryConfig ( )

default

Default configuration is.

• identification threads - 1 thread
• gallery type - PRINT_ICS_TEMPLATE

References PRINT_ICS_TEMPLATE.

Member Function Documentation

GetGalleryType()

ModalitiesGalleryType GetGalleryType ( ) const

inlinenodiscard

Get type of Modalities Gallery.

Default type is PRINT_ICS_TEMPLATE.

Returns

type of gallery

GetThreadCount()

unsigned int GetThreadCount ( ) const

inlinenodiscard

Get number of processing threads.

Returns

number of threads

SetGalleryType()

void SetGalleryType ( ModalitiesGalleryType value )

inline

Set type of Modalities Gallery.

Default type is PRINT_ICS_TEMPLATE.

Parameters

value

from the enum ModalitiesGalleryType

Exceptions

EnrollmentInvalidArgumentException

when value is not in range of the enum ModalitiesGalleryType

References PRINT_EMBEDDING, and PRINT_ICS_TEMPLATE.

Referenced by ModalitiesGallery::Create().

Here is the caller graph for this function:

SetThreadsCount()

void SetThreadsCount ( unsigned int value )

inline

Set number of threads used by gallery.

Note

The 'multithreaded-galleries' feature MUST be allowed in license to allow using threads. Default value is 1.

Parameters

value

it MUST be greater as 0

Exceptions

EnrollmentInvalidArgumentException

when value is 0

ToIndexedModalitiesGalleryConfig()

IndexedModalitiesGalleryConfig ToIndexedModalitiesGalleryConfig ( ) const

inlinenodiscard

Function converts configuration to IndexedModalitiesGalleryConfig.

Returns

IndexedModalitiesGalleryConfig

References PRINT_EMBEDDING, PRINT_ICS_TEMPLATE, IndexedModalitiesGalleryConfig::SetGalleryType(), and IndexedModalitiesGalleryConfig::SetThreadsCount().

Referenced by ModalitiesGallery::Create().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteTo()

void WriteTo ( Writer & writer ) const

inlinefinalvirtual

Function serializes configuration via provided Writer.

Parameters

writer

used to serialize Config.

Implements Serializable.

---

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

• ModalitiesGallery.h