eVision::EMailBarcodeReader Class Reference

Manages a complete context for a Mail Barcode Reader. More...

#include <eVision/EasyBarCode/EasyMailBarcode/EMailBarcodeReader.h>

Collaboration diagram for eVision::EMailBarcodeReader:

Public Member Functions
	EMailBarcodeReader ()
	Constructs an EMailBarcodeReader context.
	EMailBarcodeReader (const eVision::EMailBarcodeReader &other)
	Constructs an EMailBarcodeReader context.
virtual	~EMailBarcodeReader () throw ()
eVision::EMailBarcodeReader &	operator= (const eVision::EMailBarcodeReader &other)
	Assignment operator.
void	SetExpectedSymbologies (int symbologies)
	Expected symbologies for the Mail Barcode detection.
int	GetExpectedSymbologies () const
	Expected symbologies for the Mail Barcode detection.
void	SetExpectedOrientations (int orientations)
	Expected barcode orientations for the Mail Barcode detection.
int	GetExpectedOrientations () const
	Expected barcode orientations for the Mail Barcode detection.
void	SetValidateChecksum (bool validateChecksum)
	Configures the reader to return barcodes even if their checksum is incorrect.
bool	GetValidateChecksum () const
	Configures the reader to return barcodes even if their checksum is incorrect.
void	SetEnableDottedBarcodes (bool enable)
	Enables dotted barcode support.
bool	GetEnableDottedBarcodes () const
	Enables dotted barcode support.
void	SetEnableClutteredBarcodes (bool enable)
	Enables cluttered barcode (barcode with fused bars) support.
bool	GetEnableClutteredBarcodes () const
	Enables cluttered barcode (barcode with fused bars) support.
void	Save (eVision::ESerializer *serializer)
	Saves the current settings of the EMailBarcodeReader::EMailBarcodeReader object.
void	Save (const std::string &path)
	Saves the current settings of the EMailBarcodeReader::EMailBarcodeReader object.
void	Load (eVision::ESerializer *serializer)
	Loads the settings of the EMailBarcodeReader::EMailBarcodeReader object, from disk.
void	Load (const std::string &path)
	Loads the settings of the EMailBarcodeReader::EMailBarcodeReader object, from disk.
std::vector< eVision::EMailBarcode >	Read (const eVision::EROIBW8 &roi)
	Locates and decodes mail barcodes.
	EMailBarcodeReader (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

Manages a complete context for a Mail Barcode Reader.

License(s): EasyBarCode

Constructor & Destructor Documentation

EMailBarcodeReader() [1/3]

eVision::EMailBarcodeReader::EMailBarcodeReader

(

)

Constructs an EMailBarcodeReader context.

EMailBarcodeReader() [2/3]

eVision::EMailBarcodeReader::EMailBarcodeReader

(

const eVision::EMailBarcodeReader &

other

)

Constructs an EMailBarcodeReader context.

Parameters

other

Another EMailBarcodeReader to construct the EMailBarcodeReader from.

~EMailBarcodeReader()

eVision::EMailBarcodeReader::~EMailBarcodeReader ( ) throw (  )

virtual

EMailBarcodeReader() [3/3]

eVision::EMailBarcodeReader::EMailBarcodeReader

(

CppWrapperInternal::InternalConstructor

)

Member Function Documentation

GetEnableClutteredBarcodes()

bool eVision::EMailBarcodeReader::GetEnableClutteredBarcodes

(

)

const

Enables cluttered barcode (barcode with fused bars) support.

GetEnableDottedBarcodes()

bool eVision::EMailBarcodeReader::GetEnableDottedBarcodes

(

)

const

Enables dotted barcode support.

GetExpectedOrientations()

int eVision::EMailBarcodeReader::GetExpectedOrientations

(

)

const

Expected barcode orientations for the Mail Barcode detection.

The value is a combination of the members of the EMailBarcodeOrientation enumerate.

GetExpectedSymbologies()

int eVision::EMailBarcodeReader::GetExpectedSymbologies

(

)

const

Expected symbologies for the Mail Barcode detection.

The value is a combination of the members of the EMailBarcodeSymbologies enumerate.

GetValidateChecksum()

bool eVision::EMailBarcodeReader::GetValidateChecksum

(

)

const

Configures the reader to return barcodes even if their checksum is incorrect.

Load() [1/2]

void eVision::EMailBarcodeReader::Load

(

const std::string &

path

)

Loads the settings of the EMailBarcodeReader::EMailBarcodeReader object, from disk.

Parameters

path	A string containing the full path to the file.

Load() [2/2]

void eVision::EMailBarcodeReader::Load

(

eVision::ESerializer *

serializer

)

Loads the settings of the EMailBarcodeReader::EMailBarcodeReader object, from disk.

Parameters

serializer

The serializer.

operator=()

eVision::EMailBarcodeReader & eVision::EMailBarcodeReader::operator=

(

const eVision::EMailBarcodeReader &

other

)

Assignment operator.

Parameters

other

Another EMailBarcodeReader to copy into the EMailBarcodeReader.

Read()

std::vector< eVision::EMailBarcode > eVision::EMailBarcodeReader::Read

(

const eVision::EROIBW8 &

roi

)

Locates and decodes mail barcodes.

Parameters

roi	The ROI/Image in which to search for mail barcodes.

This method returns the list of the detected barcodes.

Save() [1/2]

void eVision::EMailBarcodeReader::Save

(

const std::string &

path

)

Saves the current settings of the EMailBarcodeReader::EMailBarcodeReader object.

Parameters

path	A string containing the full path to the file.

It is advised to use a file extension that is non-standard (for instance *.mbr).

Save() [2/2]

void eVision::EMailBarcodeReader::Save

(

eVision::ESerializer *

serializer

)

Saves the current settings of the EMailBarcodeReader::EMailBarcodeReader object.

Parameters

serializer

The serializer.

It is advised to use a file extension that is non-standard (for instance *.mbr).

SetEnableClutteredBarcodes()

void eVision::EMailBarcodeReader::SetEnableClutteredBarcodes

(

bool

enable

)

Enables cluttered barcode (barcode with fused bars) support.

SetEnableDottedBarcodes()

void eVision::EMailBarcodeReader::SetEnableDottedBarcodes

(

bool

enable

)

Enables dotted barcode support.

SetExpectedOrientations()

void eVision::EMailBarcodeReader::SetExpectedOrientations

(

int

orientations

)

Expected barcode orientations for the Mail Barcode detection.

The value is a combination of the members of the EMailBarcodeOrientation enumerate.

SetExpectedSymbologies()

void eVision::EMailBarcodeReader::SetExpectedSymbologies

(

int

symbologies

)

Expected symbologies for the Mail Barcode detection.

The value is a combination of the members of the EMailBarcodeSymbologies enumerate.

SetValidateChecksum()

void eVision::EMailBarcodeReader::SetValidateChecksum

(

bool

validateChecksum

)

Configures the reader to return barcodes even if their checksum is incorrect.

Member Data Documentation

wrappedClass_

CppWrapperInternal::WrappedClass eVision::EMailBarcodeReader::wrappedClass_