PrintTemplate Class Reference

Holds various biometric representation types for print. More...

#include <PrintTemplate.h>

Collaboration diagram for PrintTemplate:

Public Member Functions
std::shared_ptr< ICSTemplate >	GetICSRepresentation () const
	Provides ICS (Innovatrics proprietary extracted template) representation of print.
std::shared_ptr< EmbeddingTemplate >	GetEmbeddingRepresentation () const
	Retrieves the embedding representation associated with the object.
bool	HasIcsRepresentation () const
	Checks if the object has an ICS representation.
bool	HasEmbeddingRepresentation () const
	Checks if the object has an embedding representation.
void	WriteTo (Writer &writer) const final
	It serializes applicant print via provided Writer.
	PrintTemplate (std::shared_ptr< ICSTemplate > icsTemplate)
	Constructs an PrintTemplate object with the provided ICSTemplate.
	PrintTemplate (std::shared_ptr< ICSTemplate > icsTemplate, std::shared_ptr< EmbeddingTemplate > embedding)
	Constructs an PrintTemplate object with the provided ICSTemplate and embedding.
	PrintTemplate (std::shared_ptr< EmbeddingTemplate > embedding)
	Constructs an PrintTemplate object with the provided embedding.

Static Public Member Functions
static std::vector< std::shared_ptr< ICSTemplate > >	ToICSTemplates (const std::vector< std::shared_ptr< PrintTemplate > > &templates)
	Converts a PrintTemplate objects into a ICSTemplate objects.
static std::vector< std::shared_ptr< EmbeddingTemplate > >	ToEmbeddingTemplates (const std::vector< std::shared_ptr< PrintTemplate > > &templates)
	Converts a PrintTemplate objects into an EmbeddingTemplate objects.

Detailed Description

Holds various biometric representation types for print.

Constructor & Destructor Documentation

PrintTemplate() [1/3]

PrintTemplate ( std::shared_ptr< ICSTemplate > icsTemplate )

inlineexplicit

Constructs an PrintTemplate object with the provided ICSTemplate.

This constructor initializes an PrintTemplate object with the given ICSTemplate.

Parameters

icsTemplate

A shared pointer to the ICSTemplate object to be associated with the PrintTemplate.

Exceptions

NullArgumentException

Thrown if the provided ICSTemplate pointer is null.

PrintTemplate() [2/3]

PrintTemplate ( std::shared_ptr< ICSTemplate > icsTemplate, std::shared_ptr< EmbeddingTemplate > embedding )

inline

Constructs an PrintTemplate object with the provided ICSTemplate and embedding.

This constructor initializes an PrintTemplate object with the given ICSTemplate and EmbeddingTemplate.

Parameters

icsTemplate	A shared pointer to the ICSTemplate object to be associated with the PrintTemplate.
embedding	A shared pointer to the EmbeddingTemplate object to be associated with the PrintTemplate.

Exceptions

NullArgumentException	if the provided ICSTemplate pointer is null.
NullArgumentException	if the provided EmbeddingTemplate pointer is null.
EnrollmentInvalidArgumentException	if ICS template and Embedding positions are different.

PrintTemplate() [3/3]

PrintTemplate ( std::shared_ptr< EmbeddingTemplate > embedding )

inlineexplicit

Constructs an PrintTemplate object with the provided embedding.

This constructor initializes an PrintTemplate object with the given EmbeddingTemplate.

Parameters

embedding

A shared pointer to the EmbeddingTemplate object to be associated with the PrintTemplate.

Exceptions

NullArgumentException

if the provided EmbeddingTemplate pointer is null.

Member Function Documentation

GetEmbeddingRepresentation()

std::shared_ptr< EmbeddingTemplate > GetEmbeddingRepresentation ( ) const

inlinenodiscard

Retrieves the embedding representation associated with the object.

This function retrieves the embedding representation associated with the object.

Returns

A EmbeddingTemplate associated with the object.

A nullptr if no embedding representation is associated.

GetICSRepresentation()

std::shared_ptr< ICSTemplate > GetICSRepresentation ( ) const

inlinenodiscard

Provides ICS (Innovatrics proprietary extracted template) representation of print.

Returns

ICSTemplate

Referenced by ANSITemplateAdapter::Adapt(), ILOSIDTemplateAdapter::Adapt(), ISOCCTemplateAdapter::Adapt(), ISONCTemplateAdapter::Adapt(), and ISOTemplateAdapter::Adapt().

Here is the caller graph for this function:

HasEmbeddingRepresentation()

bool HasEmbeddingRepresentation ( ) const

inlinenodiscard

Checks if the object has an embedding representation.

This function checks whether the object has an embedding representation associated with it.

Returns

true if the object has an embedding representation, false otherwise.

HasIcsRepresentation()

bool HasIcsRepresentation ( ) const

inlinenodiscard

Checks if the object has an ICS representation.

This function checks whether the object has an Innovatrics' proprietary representation associated with it.

Returns

true if the object has an ICS representation, false otherwise.

ToEmbeddingTemplates()

std::vector< std::shared_ptr< EmbeddingTemplate > > ToEmbeddingTemplates ( const std::vector< std::shared_ptr< PrintTemplate > > & templates )

inlinestatic

Converts a PrintTemplate objects into an EmbeddingTemplate objects.

This function takes a PrintTemplate objects and converts each element into an EmbeddingTemplate object, then returns a EmbeddingTemplate objects. When PrintTemplate does not contain EmbeddingTemplate then null is provided.

Parameters

templates

A PrintTemplate objects to be converted.

Returns

A EmbeddingTemplate objects converted from the PrintTemplate objects.

Referenced by ModalitiesEmbeddingVerifyMatcher::MatchPrints().

Here is the caller graph for this function:

ToICSTemplates()

std::vector< std::shared_ptr< ICSTemplate > > ToICSTemplates ( const std::vector< std::shared_ptr< PrintTemplate > > & templates )

inlinestatic

Converts a PrintTemplate objects into a ICSTemplate objects.

This function takes a PrintTemplate objects and converts each element into an ICSTemplate object, then returns a ICSTemplate objects.

Parameters

templates

A PrintTemplate objects to be converted. When PrintTemplate does not contain ICSTemplate then null is provided.

Returns

A ICSTemplate objects converted from the PrintTemplate objects.

Referenced by ModalitiesVerifyMatcher::MatchPrints(), and ModalitiesTemplate::ToModalitiesICSTemplate().

Here is the caller graph for this function:

WriteTo()

void WriteTo ( Writer & writer ) const

inlinefinalvirtual

It serializes applicant print via provided Writer.

Parameters

writer

used to serialize PrintTemplate.

Implements Serializable.

---

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

• Print/PrintTemplate.h