Result of SignDocSignatureData::matchSignature(), SignDocSignatureData::matchReference(), SignDocImage::matchSignature(), and SignDocImage::matchReference(). More...

#include <SignDocSDK-cpp.h>

Public Member Functions
	SignDocMatchResult ()
	Constructor. More...

	SignDocMatchResult (const SignDocMatchResult &aSource)
	Copy constructor. More...

	~SignDocMatchResult ()
	Destructor. More...

SignDocMatchResult &	operator= (const SignDocMatchResult &aSource)
	Assignment operator. More...

void	swap (SignDocMatchResult &aOther)
	Efficiently swap this object with another one. More...

ReturnCode	getNumberOfStaticResults (int &aOutput) const
	Get the number of results for the static matching engine. More...

ReturnCode	getDynamicMatchQuality (int &aOutput) const
	Get the dynamic match quality. More...

ReturnCode	getDStatMatchQuality (int &aOutput) const
	Get the DStat match quality. More...

ReturnCode	getStaticMatchQuality (int aIndex, int &aOutput) const
	Get the static match quality. More...

ReturnCode	getResult (bool &aOutput) const
	Get the overall match result. More...

ReturnCode	getDynamicResult (bool &aOutput) const
	Get the dynamic match result. More...

ReturnCode	getDStatResult (bool &aOutput) const
	Get the DStat match result. More...

ReturnCode	getStaticResult (int aIndex, bool &aOutput) const
	Get a static match result. More...

const char *	getErrorMessage (Encoding aEncoding) const
	Get an error message for the last function call. More...

const wchar_t *	getErrorMessageW () const
	Get an error message for the last function call. More...

	SignDocMatchResult (SIGNDOC_MatchResult *aP)
	Internal function. More...

SIGNDOC_MatchResult *	getImpl ()
	Internal function. More...

const SIGNDOC_MatchResult *	getImpl () const
	Internal function. More...

void	setImpl (SIGNDOC_MatchResult *aP)
	Internal function. More...

Detailed Description

Result of SignDocSignatureData::matchSignature(), SignDocSignatureData::matchReference(), SignDocImage::matchSignature(), and SignDocImage::matchReference().

Constructor & Destructor Documentation

SignDocMatchResult ( )

inline

Constructor.

No results will be set.

SignDocMatchResult ( const SignDocMatchResult & aSource )

inline

Copy constructor.

Parameters

[in] aSource The object to be copied.

~SignDocMatchResult ( )

inline

Destructor.

SignDocMatchResult ( SIGNDOC_MatchResult * aP )

inline

Internal function.

Member Function Documentation

ReturnCode getDStatMatchQuality ( int & aOutput ) const

inline

Get the DStat match quality.

Parameters

[out] aOutput The match quality (0 through 100) computed by the DStat engine or a negative value if the DStat match quality has not been computed.

Returns: ReturnCode::rc_ok iff successful.

See also: getDStatResult(), getDynamicMatchQuality(), getStaticMatchQuality()

ReturnCode getDStatResult ( bool & aOutput ) const

inline

Get the DStat match result.

Parameters

[out] aOutput true for a match reported by the DStat matching engine, false otherwise.

Returns: ReturnCode::rc_ok iff successful.

See also: getDStatMatchQuality(), getResult()

ReturnCode getDynamicMatchQuality ( int & aOutput ) const

inline

Get the dynamic match quality.

Parameters

[out] aOutput The match quality (0 through 100) computed by the dynamic matching engine or a negative value if the dynamic match quality has not been computed.

Returns: ReturnCode::rc_ok iff successful.

See also: getDStatMatchQuality(), getDynamicResult(), getStaticMatchQuality()

ReturnCode getDynamicResult ( bool & aOutput ) const

inline

Get the dynamic match result.

Parameters

[out] aOutput true for a match reported by the dynamic matching engine, false otherwise.

Returns: ReturnCode::rc_ok iff successful.

See also: getDynamicMatchQuality(), getResult()

const char * getErrorMessage ( Encoding aEncoding ) const

inline

Get an error message for the last function call.

Parameters

[in] aEncoding The encoding to be used for the error message.

Returns: A pointer to a string describing the reason for the failure of the last function call. The string is empty if the last call succeeded. The pointer is valid until this object is destroyed or a member function of this object is called.

See also: getErrorMessageW()

const wchar_t * getErrorMessageW ( ) const

inline

Get an error message for the last function call.

Returns: A pointer to a string describing the reason for the failure of the last function call. The string is empty if the last call succeeded. The pointer is valid until this object is destroyed or a member function of this object is called.

See also: getErrorMessage()

SIGNDOC_MatchResult* getImpl ( )

inline

Internal function.

const SIGNDOC_MatchResult* getImpl ( ) const

inline

Internal function.

ReturnCode getNumberOfStaticResults ( int & aOutput ) const

inline

Get the number of results for the static matching engine.

References contain more than one signature, therefore there are multiple results for the static matching engine, one per signature in the reference.

Parameters

[out] aOutput The number of results.

Returns: ReturnCode::rc_ok iff successful.

See also: getStaticMatchQuality(), getStaticResult()

ReturnCode getResult ( bool & aOutput ) const

inline

Get the overall match result.

Parameters

[out] aOutput true if all signatures match for all enabled matching engines, false otherwise.

Returns: ReturnCode::rc_ok iff successful.

See also: getDStatResult(), getDynamicResult(), getStaticResult()

ReturnCode getStaticMatchQuality	(	int	aIndex,
		int &	aOutput
	)		const

inline

Get the static match quality.

References contain more than one signature, therefore there are multiple results for the static matching engine, one per signature in the reference.

Parameters

[in]	aIndex	0-based index of the match result.
[out]	aOutput	The match quality (0 through 100) computed by the static matching engine or a negative value if the static match quality has not been computed.

Returns: ReturnCode::rc_ok iff successful.

See also: getDStatMatchQuality(), getDynamicMatchQuality(), getStaticResult(), getNumberOfStaticResults()

ReturnCode getStaticResult	(	int	aIndex,
		bool &	aOutput
	)		const

inline

Get a static match result.

References contain more than one signature, therefore there are multiple results, one per signature in the reference.

Parameters

[in]	aIndex	0-based index of the match result.
[out]	aOutput	true for a match reported by the static matching engine, false otherwise.

Returns: ReturnCode::rc_ok iff successful.

See also: getNumberOfStaticResults(), getStaticMatchQuality(), getResult()

SignDocMatchResult & operator= ( const SignDocMatchResult & aSource )

inline

Assignment operator.

Parameters

[in] aSource The source object.

Returns: This object.

void setImpl ( SIGNDOC_MatchResult * aP )

inline

Internal function.

void swap ( SignDocMatchResult & aOther )

inline

Efficiently swap this object with another one.

Parameters

[in] aOther The other object.

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

SignDocSDK-cpp.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation