eVision::ESearchParamsType Class Reference

This class is instantiated once in each EMatrixCodeReader and represents the search parameters that are explored when reading a EMatrixCode. More...

#include <eVision/EasyMatrixCode/EasyMatrixCode1/ESearchParamsType.h>

Collaboration diagram for eVision::ESearchParamsType:

Public Member Functions
virtual	~ESearchParamsType () throw ()
void	AddLogicalSize (eVision::ELogicalSize searchLogicalSize)
	Adds a new logical size to the list of ELogicalSize the candidate is matched against at read time.
void	ClearLogicalSize ()
	Clears the list of logical sizes the candidate is matched against at read time.
void	RemoveLogicalSize (eVision::ELogicalSize searchLogicalSize)
	Removes the logical size from the list of ELogicalSize the candidate is matched against at read time.
int32_t	GetLogicalSizeCount () const
	The size of the list of ELogicalSize the candidate is matched against at read time.
eVision::ELogicalSize	GetLogicalSize (int32_t index)
	Gets an item in the list of ELogicalSize the candidate is matched against at read time.
void	AddContrast (eVision::EMatrixCodeContrastMode searchContrast)
	Adds a new contrast mode to the list of EMatrixCodeContrastMode the candidate is matched against at read time.
void	ClearContrast ()
	Clears the list of contrast modes the candidate is matched against at read time.
void	RemoveContrast (eVision::EMatrixCodeContrastMode searchContrast)
	Removes the contrast mode from the list of EMatrixCodeContrastMode the candidate is matched against at read time.
int32_t	GetContrastCount () const
	The size of the list of EMatrixCodeContrastMode the candidate is matched against at read time.
eVision::EMatrixCodeContrastMode	GetContrast (int32_t index)
	Gets an item in the list of EMatrixCodeContrastMode the candidate is matched against at read time.
void	AddFlipping (eVision::EFlipping searchFlipping)
	Adds a new flipping to the list of EFlipping the candidate is matched against at read time.
void	ClearFlipping ()
	Clears the list of flippings the candidate is matched against at read time.
void	RemoveFlipping (eVision::EFlipping searchFlipping)
	Removes the flipping from the list of EFlipping the candidate is matched against at read time.
int32_t	GetFlippingCount () const
	The size of the list of EFlipping the candidate is matched against at read time.
eVision::EFlipping	GetFlipping (int32_t index)
	Gets an item in the list of EFlipping the candidate is matched against at read time.
void	AddFamily (eVision::EFamily searchFamily)
	Adds a new family to the list of EFamily the candidate is matched against at read time.
void	ClearFamily ()
	Clears the list of families the candidate is matched against at read time.
void	RemoveFamily (eVision::EFamily searchFamily)
	Removes the family from the list of EFamily the candidate is matched against at read time.
int32_t	GetFamilyCount () const
	The size of the list of EFamily the candidate is matched against at read time.
eVision::EFamily	GetFamily (int32_t index)
	Gets an item in the list of EFamily the candidate is matched against at read time.
	ESearchParamsType (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

This class is instantiated once in each EMatrixCodeReader and represents the search parameters that are explored when reading a EMatrixCode.

This class contains 4 sets of search parameters that are scanned at read time. At EMatrixCodeReader construction time, these sets of values are initialized with all possible values. This means, for instance, that a data matrix code read in a freshly created reader is matched against all possible logical sizes. As a consequence, the default values of these sets are not repeated here. They are assumed to represent every possible search parameters. The ESearchParamsType object needs to be used only if you wish to "override" the learning process.

License(s): None

Deprecated

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

Constructor & Destructor Documentation

~ESearchParamsType()

eVision::ESearchParamsType::~ESearchParamsType ( ) throw (  )

virtual

ESearchParamsType()

eVision::ESearchParamsType::ESearchParamsType

(

CppWrapperInternal::InternalConstructor

)

Member Function Documentation

AddContrast()

void eVision::ESearchParamsType::AddContrast

(

eVision::EMatrixCodeContrastMode

searchContrast

)

Adds a new contrast mode to the list of EMatrixCodeContrastMode the candidate is matched against at read time.

Parameters

searchContrast

Contrast mode to add to the list.

AddFamily()

void eVision::ESearchParamsType::AddFamily

(

eVision::EFamily

searchFamily

)

Adds a new family to the list of EFamily the candidate is matched against at read time.

Parameters

searchFamily

Family to add to the list.

AddFlipping()

void eVision::ESearchParamsType::AddFlipping

(

eVision::EFlipping

searchFlipping

)

Adds a new flipping to the list of EFlipping the candidate is matched against at read time.

Parameters

searchFlipping

Flipping to add to the list.

AddLogicalSize()

void eVision::ESearchParamsType::AddLogicalSize

(

eVision::ELogicalSize

searchLogicalSize

)

Adds a new logical size to the list of ELogicalSize the candidate is matched against at read time.

Parameters

searchLogicalSize

Logical size to add to the list.

ClearContrast()

void eVision::ESearchParamsType::ClearContrast

(

)

Clears the list of contrast modes the candidate is matched against at read time.

ClearFamily()

void eVision::ESearchParamsType::ClearFamily

(

)

Clears the list of families the candidate is matched against at read time.

ClearFlipping()

void eVision::ESearchParamsType::ClearFlipping

(

)

Clears the list of flippings the candidate is matched against at read time.

ClearLogicalSize()

void eVision::ESearchParamsType::ClearLogicalSize

(

)

Clears the list of logical sizes the candidate is matched against at read time.

GetContrast()

eVision::EMatrixCodeContrastMode eVision::ESearchParamsType::GetContrast

(

int32_t

index

)

Gets an item in the list of EMatrixCodeContrastMode the candidate is matched against at read time.

Parameters

index

Position in the list.

GetContrastCount()

int32_t eVision::ESearchParamsType::GetContrastCount

(

)

const

The size of the list of EMatrixCodeContrastMode the candidate is matched against at read time.

GetFamily()

eVision::EFamily eVision::ESearchParamsType::GetFamily

(

int32_t

index

)

Gets an item in the list of EFamily the candidate is matched against at read time.

Parameters

index

Position in the list.

GetFamilyCount()

int32_t eVision::ESearchParamsType::GetFamilyCount

(

)

const

The size of the list of EFamily the candidate is matched against at read time.

GetFlipping()

eVision::EFlipping eVision::ESearchParamsType::GetFlipping

(

int32_t

index

)

Gets an item in the list of EFlipping the candidate is matched against at read time.

Parameters

index

Position in the list.

GetFlippingCount()

int32_t eVision::ESearchParamsType::GetFlippingCount

(

)

const

The size of the list of EFlipping the candidate is matched against at read time.

GetLogicalSize()

eVision::ELogicalSize eVision::ESearchParamsType::GetLogicalSize

(

int32_t

index

)

Gets an item in the list of ELogicalSize the candidate is matched against at read time.

Parameters

index

Position in the list.

GetLogicalSizeCount()

int32_t eVision::ESearchParamsType::GetLogicalSizeCount

(

)

const

The size of the list of ELogicalSize the candidate is matched against at read time.

RemoveContrast()

void eVision::ESearchParamsType::RemoveContrast

(

eVision::EMatrixCodeContrastMode

searchContrast

)

Removes the contrast mode from the list of EMatrixCodeContrastMode the candidate is matched against at read time.

Parameters

searchContrast

Contrast mode to remove from the list.

RemoveFamily()

void eVision::ESearchParamsType::RemoveFamily

(

eVision::EFamily

searchFamily

)

Removes the family from the list of EFamily the candidate is matched against at read time.

Parameters

searchFamily

Family to remove from the list.

RemoveFlipping()

void eVision::ESearchParamsType::RemoveFlipping

(

eVision::EFlipping

searchFlipping

)

Removes the flipping from the list of EFlipping the candidate is matched against at read time.

Parameters

searchFlipping

Flipping to remove from the list.

RemoveLogicalSize()

void eVision::ESearchParamsType::RemoveLogicalSize

(

eVision::ELogicalSize

searchLogicalSize

)

Removes the logical size from the list of ELogicalSize the candidate is matched against at read time.

Parameters

searchLogicalSize

Logical size to remove from the list.

Member Data Documentation

wrappedClass_

CppWrapperInternal::WrappedClass eVision::ESearchParamsType::wrappedClass_