eVision::EMailBarcode Class Reference

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

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

Collaboration diagram for eVision::EMailBarcode:

Public Member Functions
	EMailBarcode (const eVision::EMailBarcode &other)
	Constructs an EMailBarcode.
virtual	~EMailBarcode () throw ()
eVision::EMailBarcode &	operator= (const eVision::EMailBarcode &other)
	Assignment operator.
eVision::EMailBarcodeSymbologies	GetSymbology () const
	Returns the symbology of the mail barcode.
eVision::EMailBarcodeOrientation	GetOrientation () const
	Returns the orientation of the mail barcode.
std::string	GetText () const
	Returns the full decoded text, also called decoded string, of the mail barcode.
std::vector< eVision::EStringPair >	GetComponentStrings () const
	Returns the list of semantic parts included in the mail barcode text.
eVision::ERectangle	GetPosition () const
	Returns the position of the mail barcode in the Image/ROI.
bool	GetChecksumOk () const
	Returns if the checksum was successfully validated.
void	Draw (eVision::EDrawAdapter *adapter, float zoomX, float zoomY, float panX, float panY) const
	Draws the bounding box of the mail barcode.
void	Draw (eVision::EDrawAdapter *adapter, float zoomX, float zoomY, float panX) const
	Draws the bounding box of the mail barcode.
void	Draw (eVision::EDrawAdapter *adapter, float zoomX, float zoomY) const
	Draws the bounding box of the mail barcode.
void	Draw (eVision::EDrawAdapter *adapter, float zoomX) const
	Draws the bounding box of the mail barcode.
void	Draw (eVision::EDrawAdapter *adapter) const
	Draws the bounding box of the mail barcode.
void	Draw (HDC hDC, float zoomX, float zoomY, float panX, float panY) const
	Draws the bounding box of the mail barcode.
void	Draw (HDC hDC, float zoomX, float zoomY, float panX) const
	Draws the bounding box of the mail barcode.
void	Draw (HDC hDC, float zoomX, float zoomY) const
	Draws the bounding box of the mail barcode.
void	Draw (HDC hDC, float zoomX) const
	Draws the bounding box of the mail barcode.
void	Draw (HDC hDC) const
	Draws the bounding box of the mail barcode.
void	DrawDecodedString (eVision::EDrawAdapter *drawAdapter, float zoomX, float zoomY, float panX, float panY) const
	Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.
void	DrawDecodedString (eVision::EDrawAdapter *drawAdapter, float zoomX, float zoomY, float panX) const
	Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.
void	DrawDecodedString (eVision::EDrawAdapter *drawAdapter, float zoomX, float zoomY) const
	Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.
void	DrawDecodedString (eVision::EDrawAdapter *drawAdapter, float zoomX) const
	Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.
void	DrawDecodedString (eVision::EDrawAdapter *drawAdapter) const
	Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.
void	DrawDecodedString (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame, float zoomX, float zoomY, float panX, float panY) const
	Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.
void	DrawDecodedString (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame, float zoomX, float zoomY, float panX) const
	Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.
void	DrawDecodedString (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame, float zoomX, float zoomY) const
	Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.
void	DrawDecodedString (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame, float zoomX) const
	Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.
void	DrawDecodedString (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame) const
	Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.
	EMailBarcode (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

Manages a complete context for a Mail Barcode.

License(s): EasyBarCode

Constructor & Destructor Documentation

EMailBarcode() [1/2]

eVision::EMailBarcode::EMailBarcode

(

const eVision::EMailBarcode &

other

)

Constructs an EMailBarcode.

Parameters

other

The other EMailBarcode that we will copy into this one.

~EMailBarcode()

eVision::EMailBarcode::~EMailBarcode ( ) throw (  )

virtual

EMailBarcode() [2/2]

eVision::EMailBarcode::EMailBarcode

(

CppWrapperInternal::InternalConstructor

)

Member Function Documentation

Draw() [1/10]

void eVision::EMailBarcode::Draw

(

eVision::EDrawAdapter *

adapter

)

const

Draws the bounding box of the mail barcode.

Parameters

adapter

EDrawAdapter that will be used to draw.

Draw() [2/10]

void eVision::EMailBarcode::Draw	(	eVision::EDrawAdapter *	adapter,
		float	zoomX ) const

Draws the bounding box of the mail barcode.

Parameters

adapter	EDrawAdapter that will be used to draw.
zoomX	Horizontal zooming factor. By default, true scale is used.

Draw() [3/10]

void eVision::EMailBarcode::Draw	(	eVision::EDrawAdapter *	adapter,
		float	zoomX,
		float	zoomY ) const

Draws the bounding box of the mail barcode.

Parameters

adapter	EDrawAdapter that will be used to draw.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

Draw() [4/10]

void eVision::EMailBarcode::Draw	(	eVision::EDrawAdapter *	adapter,
		float	zoomX,
		float	zoomY,
		float	panX ) const

Draws the bounding box of the mail barcode.

Parameters

adapter	EDrawAdapter that will be used to draw.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

Draw() [5/10]

void eVision::EMailBarcode::Draw	(	eVision::EDrawAdapter *	adapter,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY ) const

Draws the bounding box of the mail barcode.

Parameters

adapter	EDrawAdapter that will be used to draw.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

Draw() [6/10]

void eVision::EMailBarcode::Draw

(

HDC

hDC

)

const

Draws the bounding box of the mail barcode.

Parameters

hDC	Handle of the device context on which to draw.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

Draw() [7/10]

void eVision::EMailBarcode::Draw	(	HDC	hDC,
		float	zoomX ) const

Draws the bounding box of the mail barcode.

Parameters

hDC	Handle of the device context on which to draw.
zoomX	Horizontal zooming factor. By default, true scale is used.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

Draw() [8/10]

void eVision::EMailBarcode::Draw	(	HDC	hDC,
		float	zoomX,
		float	zoomY ) const

Draws the bounding box of the mail barcode.

Parameters

hDC	Handle of the device context on which to draw.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

Draw() [9/10]

void eVision::EMailBarcode::Draw	(	HDC	hDC,
		float	zoomX,
		float	zoomY,
		float	panX ) const

Draws the bounding box of the mail barcode.

Parameters

hDC	Handle of the device context on which to draw.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

Draw() [10/10]

void eVision::EMailBarcode::Draw	(	HDC	hDC,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY ) const

Draws the bounding box of the mail barcode.

Parameters

hDC	Handle of the device context on which to draw.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

DrawDecodedString() [1/10]

void eVision::EMailBarcode::DrawDecodedString

(

eVision::EDrawAdapter *

drawAdapter

)

const

Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters

drawAdapter

Handle of the graphics context on which to draw.

DrawDecodedString() [2/10]

void eVision::EMailBarcode::DrawDecodedString	(	eVision::EDrawAdapter *	drawAdapter,
		const eVision::EFrame &	frame ) const

Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters

drawAdapter	Handle of the graphics context on which to draw.
frame	Frame associated with the bar code.

DrawDecodedString() [3/10]

void eVision::EMailBarcode::DrawDecodedString	(	eVision::EDrawAdapter *	drawAdapter,
		const eVision::EFrame &	frame,
		float	zoomX ) const

Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters

drawAdapter	Handle of the graphics context on which to draw.
frame	Frame associated with the bar code.
zoomX	Horizontal zooming factor. By default, true scale is used.

DrawDecodedString() [4/10]

void eVision::EMailBarcode::DrawDecodedString	(	eVision::EDrawAdapter *	drawAdapter,
		const eVision::EFrame &	frame,
		float	zoomX,
		float	zoomY ) const

Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters

drawAdapter	Handle of the graphics context on which to draw.
frame	Frame associated with the bar code.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

DrawDecodedString() [5/10]

void eVision::EMailBarcode::DrawDecodedString	(	eVision::EDrawAdapter *	drawAdapter,
		const eVision::EFrame &	frame,
		float	zoomX,
		float	zoomY,
		float	panX ) const

Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters

drawAdapter	Handle of the graphics context on which to draw.
frame	Frame associated with the bar code.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

DrawDecodedString() [6/10]

void eVision::EMailBarcode::DrawDecodedString	(	eVision::EDrawAdapter *	drawAdapter,
		const eVision::EFrame &	frame,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY ) const

Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters

drawAdapter	Handle of the graphics context on which to draw.
frame	Frame associated with the bar code.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

DrawDecodedString() [7/10]

void eVision::EMailBarcode::DrawDecodedString	(	eVision::EDrawAdapter *	drawAdapter,
		float	zoomX ) const

Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters

drawAdapter	Handle of the graphics context on which to draw.
zoomX	Horizontal zooming factor. By default, true scale is used.

DrawDecodedString() [8/10]

void eVision::EMailBarcode::DrawDecodedString	(	eVision::EDrawAdapter *	drawAdapter,
		float	zoomX,
		float	zoomY ) const

Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters

drawAdapter	Handle of the graphics context on which to draw.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

DrawDecodedString() [9/10]

void eVision::EMailBarcode::DrawDecodedString	(	eVision::EDrawAdapter *	drawAdapter,
		float	zoomX,
		float	zoomY,
		float	panX ) const

Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters

drawAdapter	Handle of the graphics context on which to draw.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

DrawDecodedString() [10/10]

void eVision::EMailBarcode::DrawDecodedString	(	eVision::EDrawAdapter *	drawAdapter,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY ) const

Draws the decoded string (EMailBarcode::GetText), below the position of the EMailBarcode. The text color is the one of the pen of the drawAdapter or white if no pen is defined. The background color is the one of the brush of the drawAdapter or black if no brush is defined.

Parameters

drawAdapter	Handle of the graphics context on which to draw.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

GetChecksumOk()

bool eVision::EMailBarcode::GetChecksumOk

(

)

const

Returns if the checksum was successfully validated.

GetComponentStrings()

std::vector< eVision::EStringPair > eVision::EMailBarcode::GetComponentStrings

(

)

const

Returns the list of semantic parts included in the mail barcode text.

GetOrientation()

eVision::EMailBarcodeOrientation eVision::EMailBarcode::GetOrientation

(

)

const

Returns the orientation of the mail barcode.

GetPosition()

eVision::ERectangle eVision::EMailBarcode::GetPosition

(

)

const

Returns the position of the mail barcode in the Image/ROI.

GetSymbology()

eVision::EMailBarcodeSymbologies eVision::EMailBarcode::GetSymbology

(

)

const

Returns the symbology of the mail barcode.

GetText()

std::string eVision::EMailBarcode::GetText

(

)

const

Returns the full decoded text, also called decoded string, of the mail barcode.

operator=()

eVision::EMailBarcode & eVision::EMailBarcode::operator=

(

const eVision::EMailBarcode &

other

)

Assignment operator.

Parameters

other

The other EMailBarcode that we will copy into this one.

Member Data Documentation

wrappedClass_

CppWrapperInternal::WrappedClass eVision::EMailBarcode::wrappedClass_