eVision::ECode Class Reference

Represents a Code. More...

#include <eVision/EasyID/ECode.h>

Collaboration diagram for eVision::ECode:

Public Member Functions
	ECode ()
	Creates an ECode object.
	ECode (const eVision::ECode &other)
	Creates an ECode object.
virtual	~ECode () throw ()
eVision::ECode &	operator= (const eVision::ECode &other)
	Assignment operator.
std::string	GetDecodedString () const
	Decoded code string.
bool	GetIsGS1 () const
	Returns whether the decoded string uses the GS1 standard.
eVision::EQuadrangle	GetPosition () const
	Code position.
eVision::ERegion	ToRegion () const
	Creates an ERegion from the ECode.
eVision::EFrame	ToFrame (bool useAngle, eVision::EFrameScaling frameScaling) const
	Creates an EFrame from the ECode.
eVision::EFrame	ToFrame (bool useAngle, eVision::EFrameScaling frameScaling, const eVision::EFrame &frame) const
	Creates an EFrame from the ECode.
eVision::EPoint	GetCenter () const
	Returns the center of the ECode.
float	GetSizeX () const
	Returns the size of the ECode on its X axis. This corresponds to the mean between the sizes of the top and bottom sides of the ECode.
float	GetSizeY () const
	Returns the size of the ECode on its Y axis. This corresponds to the mean between the sizes of the left and right sides of the ECode.
float	GetAngle () const
	Returns the angle of the ECode as if it was an ERectangle.
eVision::ECodeType	GetCodeType () const
	Code type.
void	DrawPosition (eVision::EDrawAdapter *graphicsContext, float zoomX, float zoomY, float panX, float panY) const
	Draws the Position of the Code.
void	DrawPosition (eVision::EDrawAdapter *graphicsContext, float zoomX, float zoomY, float panX) const
	Draws the Position of the Code.
void	DrawPosition (eVision::EDrawAdapter *graphicsContext, float zoomX, float zoomY) const
	Draws the Position of the Code.
void	DrawPosition (eVision::EDrawAdapter *graphicsContext, float zoomX) const
	Draws the Position of the Code.
void	DrawPosition (eVision::EDrawAdapter *graphicsContext) const
	Draws the Position of the Code.
void	DrawPosition (eVision::EDrawAdapter *graphicsContext, const eVision::EFrame &frame, float zoomX, float zoomY, float panX, float panY) const
	Draws the Position of the Code.
void	DrawPosition (eVision::EDrawAdapter *graphicsContext, const eVision::EFrame &frame, float zoomX, float zoomY, float panX) const
	Draws the Position of the Code.
void	DrawPosition (eVision::EDrawAdapter *graphicsContext, const eVision::EFrame &frame, float zoomX, float zoomY) const
	Draws the Position of the Code.
void	DrawPosition (eVision::EDrawAdapter *graphicsContext, const eVision::EFrame &frame, float zoomX) const
	Draws the Position of the Code.
void	DrawPosition (eVision::EDrawAdapter *graphicsContext, const eVision::EFrame &frame) const
	Draws the Position of the Code.
void	DrawPosition (HDC graphicsContext, float zoomX, float zoomY, float panX, float panY) const
	Draws the Position of the Code.
void	DrawPosition (HDC graphicsContext, float zoomX, float zoomY, float panX) const
	Draws the Position of the Code.
void	DrawPosition (HDC graphicsContext, float zoomX, float zoomY) const
	Draws the Position of the Code.
void	DrawPosition (HDC graphicsContext, float zoomX) const
	Draws the Position of the Code.
void	DrawPosition (HDC graphicsContext) const
	Draws the Position of the Code.
void	DrawPositionWithCurrentPen (HDC hDC, float zoomX, float zoomY, float panX, float panY) const
	Draws the Position of the Code using the pen currently set in the graphical context.
void	DrawPositionWithCurrentPen (HDC hDC, float zoomX, float zoomY, float panX) const
	Draws the Position of the Code using the pen currently set in the graphical context.
void	DrawPositionWithCurrentPen (HDC hDC, float zoomX, float zoomY) const
	Draws the Position of the Code using the pen currently set in the graphical context.
void	DrawPositionWithCurrentPen (HDC hDC, float zoomX) const
	Draws the Position of the Code using the pen currently set in the graphical context.
void	DrawPositionWithCurrentPen (HDC hDC) const
	Draws the Position of the Code using the pen currently set in the graphical context.
const eVision::EasyMatrixCode2::EMatrixCode &	GetMatrixCode () const
	Returns the EMatrixCode contained in the ECode. Throws an exception if there is none.
const eVision::EasyBarCode2::EBarCode &	GetBarCode () const
	Returns the EBarCode contained in the ECode. Throws an exception if there is none.
const eVision::EQRCode &	GetQRCode () const
	Returns the EQRCode contained in the ECode. Throws an exception if there is none.
	ECode (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

Represents a Code.

License(s): EasyMatrixCode and EasyBarCode and EasyQRCode

Constructor & Destructor Documentation

ECode() [1/3]

eVision::ECode::ECode

(

)

Creates an ECode object.

ECode() [2/3]

eVision::ECode::ECode

(

const eVision::ECode &

other

)

Creates an ECode object.

Parameters

other

Another ECode object to be copied in the new ECode object.

~ECode()

eVision::ECode::~ECode ( ) throw (  )

virtual

ECode() [3/3]

eVision::ECode::ECode

(

CppWrapperInternal::InternalConstructor

)

Member Function Documentation

DrawPosition() [1/15]

void eVision::ECode::DrawPosition

(

eVision::EDrawAdapter *

graphicsContext

)

const

Draws the Position of the Code.

Parameters

graphicsContext

Handle of the graphics context on which to draw.

DrawPosition() [2/15]

void eVision::ECode::DrawPosition	(	eVision::EDrawAdapter *	graphicsContext,
		const eVision::EFrame &	frame ) const

Draws the Position of the Code.

Parameters

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

DrawPosition() [3/15]

void eVision::ECode::DrawPosition	(	eVision::EDrawAdapter *	graphicsContext,
		const eVision::EFrame &	frame,
		float	zoomX ) const

Draws the Position of the Code.

Parameters

graphicsContext	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.

DrawPosition() [4/15]

void eVision::ECode::DrawPosition	(	eVision::EDrawAdapter *	graphicsContext,
		const eVision::EFrame &	frame,
		float	zoomX,
		float	zoomY ) const

Draws the Position of the Code.

Parameters

graphicsContext	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.

DrawPosition() [5/15]

void eVision::ECode::DrawPosition	(	eVision::EDrawAdapter *	graphicsContext,
		const eVision::EFrame &	frame,
		float	zoomX,
		float	zoomY,
		float	panX ) const

Draws the Position of the Code.

Parameters

graphicsContext	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.

DrawPosition() [6/15]

void eVision::ECode::DrawPosition	(	eVision::EDrawAdapter *	graphicsContext,
		const eVision::EFrame &	frame,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY ) const

Draws the Position of the Code.

Parameters

graphicsContext	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.

DrawPosition() [7/15]

void eVision::ECode::DrawPosition	(	eVision::EDrawAdapter *	graphicsContext,
		float	zoomX ) const

Draws the Position of the Code.

Parameters

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

DrawPosition() [8/15]

void eVision::ECode::DrawPosition	(	eVision::EDrawAdapter *	graphicsContext,
		float	zoomX,
		float	zoomY ) const

Draws the Position of the Code.

Parameters

graphicsContext	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.

DrawPosition() [9/15]

void eVision::ECode::DrawPosition	(	eVision::EDrawAdapter *	graphicsContext,
		float	zoomX,
		float	zoomY,
		float	panX ) const

Draws the Position of the Code.

Parameters

graphicsContext	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.

DrawPosition() [10/15]

void eVision::ECode::DrawPosition	(	eVision::EDrawAdapter *	graphicsContext,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY ) const

Draws the Position of the Code.

Parameters

graphicsContext	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.

DrawPosition() [11/15]

void eVision::ECode::DrawPosition

(

HDC

graphicsContext

)

const

Draws the Position of the Code.

Parameters

graphicsContext

Handle of the graphics 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.

DrawPosition() [12/15]

void eVision::ECode::DrawPosition	(	HDC	graphicsContext,
		float	zoomX ) const

Draws the Position of the Code.

Parameters

graphicsContext	Handle of the graphics 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.

DrawPosition() [13/15]

void eVision::ECode::DrawPosition	(	HDC	graphicsContext,
		float	zoomX,
		float	zoomY ) const

Draws the Position of the Code.

Parameters

graphicsContext	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.

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.

DrawPosition() [14/15]

void eVision::ECode::DrawPosition	(	HDC	graphicsContext,
		float	zoomX,
		float	zoomY,
		float	panX ) const

Draws the Position of the Code.

Parameters

graphicsContext	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.

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.

DrawPosition() [15/15]

void eVision::ECode::DrawPosition	(	HDC	graphicsContext,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY ) const

Draws the Position of the Code.

Parameters

graphicsContext	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.

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.

DrawPositionWithCurrentPen() [1/5]

void eVision::ECode::DrawPositionWithCurrentPen

(

HDC

hDC

)

const

Draws the Position of the Code using the pen currently set in the graphical context.

Parameters

hDC	Handle of the device context on which to draw.

Deprecated

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

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

DrawPositionWithCurrentPen() [2/5]

void eVision::ECode::DrawPositionWithCurrentPen	(	HDC	hDC,
		float	zoomX ) const

Draws the Position of the Code using the pen currently set in the graphical context.

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 of ECode::DrawPosition taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

DrawPositionWithCurrentPen() [3/5]

void eVision::ECode::DrawPositionWithCurrentPen	(	HDC	hDC,
		float	zoomX,
		float	zoomY ) const

Draws the Position of the Code using the pen currently set in the graphical context.

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 of ECode::DrawPosition taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

DrawPositionWithCurrentPen() [4/5]

void eVision::ECode::DrawPositionWithCurrentPen	(	HDC	hDC,
		float	zoomX,
		float	zoomY,
		float	panX ) const

Draws the Position of the Code using the pen currently set in the graphical context.

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 of ECode::DrawPosition taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

DrawPositionWithCurrentPen() [5/5]

void eVision::ECode::DrawPositionWithCurrentPen	(	HDC	hDC,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY ) const

Draws the Position of the Code using the pen currently set in the graphical context.

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 of ECode::DrawPosition taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

GetAngle()

float eVision::ECode::GetAngle

(

)

const

Returns the angle of the ECode as if it was an ERectangle.

GetBarCode()

const eVision::EasyBarCode2::EBarCode & eVision::ECode::GetBarCode

(

)

const

Returns the EBarCode contained in the ECode. Throws an exception if there is none.

GetCenter()

eVision::EPoint eVision::ECode::GetCenter

(

)

const

Returns the center of the ECode.

GetCodeType()

eVision::ECodeType eVision::ECode::GetCodeType

(

)

const

Code type.

GetDecodedString()

std::string eVision::ECode::GetDecodedString

(

)

const

Decoded code string.

GetIsGS1()

bool eVision::ECode::GetIsGS1

(

)

const

Returns whether the decoded string uses the GS1 standard.

GetMatrixCode()

const eVision::EasyMatrixCode2::EMatrixCode & eVision::ECode::GetMatrixCode

(

)

const

Returns the EMatrixCode contained in the ECode. Throws an exception if there is none.

GetPosition()

eVision::EQuadrangle eVision::ECode::GetPosition

(

)

const

Code position.

If the ECode represents an EQRCode object, the EQuadrangle's corners are in the following order: top right, top left, bottom left, bottom right. If the ECode represents an EBarCode or EMatrixCode object, the EQuadrangle's corners are in the following order: top left, top right, bottom right, bottom left.

GetQRCode()

const eVision::EQRCode & eVision::ECode::GetQRCode

(

)

const

Returns the EQRCode contained in the ECode. Throws an exception if there is none.

GetSizeX()

float eVision::ECode::GetSizeX

(

)

const

Returns the size of the ECode on its X axis. This corresponds to the mean between the sizes of the top and bottom sides of the ECode.

GetSizeY()

float eVision::ECode::GetSizeY

(

)

const

Returns the size of the ECode on its Y axis. This corresponds to the mean between the sizes of the left and right sides of the ECode.

operator=()

eVision::ECode & eVision::ECode::operator=

(

const eVision::ECode &

other

)

Assignment operator.

Parameters

other

ECode object to be copied.

ToFrame() [1/2]

eVision::EFrame eVision::ECode::ToFrame	(	bool	useAngle,
		eVision::EFrameScaling	frameScaling ) const

Creates an EFrame from the ECode.

Parameters

useAngle	Whether to use the angle of the ECode in the frame.
frameScaling	How to handle the scale of the frame. EFrameScaling::EFrameScaling_UseScaling is not supported.

ToFrame() [2/2]

eVision::EFrame eVision::ECode::ToFrame	(	bool	useAngle,
		eVision::EFrameScaling	frameScaling,
		const eVision::EFrame &	frame ) const

Creates an EFrame from the ECode.

Parameters

useAngle	Whether to use the angle of the ECode in the frame.
frameScaling	How to handle the scale of the frame. EFrameScaling::EFrameScaling_UseScaling is not supported.
frame	Parent frame. Used when the ECode was read using a frame.

ToRegion()

eVision::ERegion eVision::ECode::ToRegion

(

)

const

Creates an ERegion from the ECode.

Member Data Documentation

wrappedClass_

CppWrapperInternal::WrappedClass eVision::ECode::wrappedClass_