Parameters for SignDocSignatureData::checkReference() and SignDocSignatureData::checkSignature(). More...

#include <SignDocSDK-cpp.h>

Public Types
enum	Type { t_undefined = 0, t_boolean = 1, t_integer = 2 }
	Return values of getType(). More...

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

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

	~SignDocCheckSignatureParameters ()
	Destructor. More...

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

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

void	clear ()
	Unset all parameters. More...

ReturnCode	setBoolean (const std::string &aName, bool aValue)
	Set a boolean parameter. More...

ReturnCode	setInteger (const std::string &aName, int aValue)
	Set an integer parameter. More...

const int *	getBoolean (const std::string &aName) const
	Get the value of a boolean parameter. More...

const int *	getInteger (const std::string &aName) const
	Get the value of an integer parameter. 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...

	SignDocCheckSignatureParameters (SIGNDOC_CheckSignatureParameters *aP)
	Internal function. More...

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

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

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

Static Public Member Functions
static Type	getType (const std::string &aName)
	Get the type of a parameter. More...

Detailed Description

Parameters for SignDocSignatureData::checkReference() and SignDocSignatureData::checkSignature().

Member Enumeration Documentation

enum Type

Return values of getType().

Enumerator

t_undefined

The specified parameter is not defined.

t_boolean

Boolean.

See also: getBoolean(), setBoolean()

t_integer

Integer.

See also: getInteger(), setInteger()

Constructor & Destructor Documentation

SignDocCheckSignatureParameters ( )

inline

Constructor.

No parameters will be set.

SignDocCheckSignatureParameters ( const SignDocCheckSignatureParameters & aSource )

inline

Copy constructor.

Parameters

[in] aSource The object to be copied.

~SignDocCheckSignatureParameters ( )

inline

Destructor.

SignDocCheckSignatureParameters ( SIGNDOC_CheckSignatureParameters * aP )

inline

Internal function.

Member Function Documentation

void clear ( )

inline

Unset all parameters.

After calling this function no parameters will be set.

const int * getBoolean ( const std::string & aName ) const

inline

Get the value of a boolean parameter.

This function does not set an error message.

Parameters

[in] aName The name of the parameter (case-sensitive).

Returns: A pointer to the value of the specified parameter or nullptr if the parameter is not set or is not a boolean parameter.

See also: setBoolean()

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_CheckSignatureParameters* getImpl ( )

inline

Internal function.

const SIGNDOC_CheckSignatureParameters* getImpl ( ) const

inline

Internal function.

const int * getInteger ( const std::string & aName ) const

inline

Get the value of an integer parameter.

This function does not set an error message.

Parameters

[in] aName The name of the parameter (case-sensitive).

Returns: A pointer to the value of the specified parameter or nullptr if the parameter is not set or is not an integer parameter.

See also: setInteger()

SignDocCheckSignatureParameters::Type getType ( const std::string & aName )

inlinestatic

Get the type of a parameter.

Parameters

[in] aName The name of the parameter (case-sensitive).

Returns: The type of the parameter, see enum Type.

SignDocCheckSignatureParameters & operator= ( const SignDocCheckSignatureParameters & aSource )

inline

Assignment operator.

Parameters

[in] aSource The source object.

Returns: This object.

ReturnCode setBoolean	(	const std::string &	aName,
		bool	aValue
	)

inline

Set a boolean parameter.

The following boolean parameter is available for use with SignDocSignatureData::checkReference():

ReferenceCheckSignatures: true to check all signatures of a reference. The default value is false.

Parameters

[in]	aName	The name of the parameter (case-sensitive).
[in]	aValue	The value of the parameter.

Returns: ReturnCode::rc_ok iff successful.

See also: getBoolean(), setInteger()

void setImpl ( SIGNDOC_CheckSignatureParameters * aP )

inline

Internal function.

ReturnCode setInteger	(	const std::string &	aName,
		int	aValue
	)

inline

Set an integer parameter.

The following integer parameters are available for use with SignDocSignatureData::checkReference():

ReferenceMinSignatures: minimum number of signatures in a reference. Set to 0 to skip the test. The default value is 3.
ReferenceMinDynamicQuality (0 through 100): minimum dynamic quality of a reference (see SignDocSignatureData::getDynamicQuality()). Set to 0 to skip the test. The default value is 60.
ReferenceMinMStaticQuality (0 through 100): minimum static quality of a reference (see SignDocSignatureData::getStaticQuality()). Set to 0 to skip the test. The default value is 80.
ReferenceMaxDuration: maximum reference capture duration in seconds. Set to 0 to skip the test. The default value is 600. The reference capture duration is computed by subtracting the smallest signature timestamp of the reference from the greatest signature timestamp of the reference.

The following integer parameters will be used by SignDocSignatureData::checkReference() if the value of boolean parameter "ReferenceCheckSignatures" is true and (unconditionally) by SignDocSignatureData::checkSignature():

SignatureMinWidth: minimum width of a signature in mm. Set to 0 to skip the test. The default value is 10.
SignatureMinHeight: minimum height of a signature in mm. Set to 0 to skip the test. The default value is 5.
SignatureMinPressureLevels (0 through 100): minimum number of different pressure levels in a signature in percent of the pressure levels provided by the capture device or 1024 (whichever is lower). Set to 0 to skip the test. The default value is 5.
SignatureMinComplexity (0 through 100): minimum static quality (see SignDocSignatureData::getComplexity()). Set to 0 to skip the test. The default value is 35.
SignatureMinSamples: minimum number of samples with positive pressure in a signature. Set to 0 to skip the test. The default value is 10.

Note: In SignWare, ReferenceMinStaticQuality is named SPReferenceMinMatch, SignatureMinSamples is named SPSignatureMinVectors, and SignatureMinComplexity is named SPSignatureMinStaticQuality.

Parameters

[in]	aName	The name of the parameter (case-sensitive).
[in]	aValue	The value of the parameter.

Returns: ReturnCode::rc_ok iff successful.

See also: getInteger(), setBoolean()

void swap ( SignDocCheckSignatureParameters & 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 Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation