Manages a complete context for the reading or verification of bar codes in EasyBarCode. More...

Inheritance diagram for eVision.EBarCode:

Collaboration diagram for eVision.EBarCode:

Public Member Functions
	EBarCode ()
	Creates an EBarCode.EBarCode object.
void	SetReadingCenter (float relativeX, float relativeY)
	Sets the reading area center coordinates, relative to the symbol position and extent.
void	SetReadingSize (float relativeSizeX, float relativeSizeY)
	Sets the reading area size, relative to the symbol extent.
void	Detect (eVision.EROIBW8 sourceImage)
	Processes the image, reads the possible contents of the bar code corresponding to all enabled symbologies and rates their likeliness.
string	Decode (eVision.ESymbologies symbology)
	Provides the decoded information (or a reading error code) corresponding to the specified symbology.
string	Read (eVision.EROIBW8 sourceImage)
	Processes the image, reads the possible contents of the bar code and returns the single possible decoding (mono-symbology) or the most likely one (multi-symbology) or a reading error code.
void	GetDecodedDirection (out bool directEncoding)
	Returns the encoding direction of the bar code, pertaining to the specified symbology, or, at least, to the most likely symbology.
void	GetDecodedDirection (eVision.ESymbologies symbology, out bool directEncoding)
	Returns the encoding direction of the bar code, pertaining to the specified symbology, or, at least, to the most likely symbology.
void	GetDecodedAngle (out float decodedAngle)
	Allows retrieving the bar code reading angle, pertaining to the specified symbology, or, at least, to the most likely symbology.
void	GetDecodedAngle (out float decodedAngle, float cutAngle)
	Allows retrieving the bar code reading angle, pertaining to the specified symbology, or, at least, to the most likely symbology.
void	GetDecodedAngle (eVision.ESymbologies symbology, out float decodedAngle)
	Allows retrieving the bar code reading angle, pertaining to the specified symbology, or, at least, to the most likely symbology.
void	GetDecodedAngle (eVision.ESymbologies symbology, out float decodedAngle, float cutAngle)
	Allows retrieving the bar code reading angle, pertaining to the specified symbology, or, at least, to the most likely symbology.
void	GetDecodedRectangle (eVision.Legacy.ERectangle rect)
	Allows retrieving the bar code reading rectangle, pertaining to the specified symbology, or, at least, to the most likely symbology.
void	GetDecodedRectangle (eVision.ESymbologies symbology, eVision.Legacy.ERectangle rect)
	Allows retrieving the bar code reading rectangle, pertaining to the specified symbology, or, at least, to the most likely symbology.
eVision.ESymbologies	GetDecodedSymbology (uint index)
	Returns the identifier of one of the symbologies that were successfully decoded.
void	Draw (eVision.EDrawAdapter graphicContext, eVision.EDrawingMode drawingMode, bool daughters)
	Draws the symbol bounding box.
void	Draw (eVision.EDrawAdapter graphicContext, eVision.EDrawingMode drawingMode)
	Draws the symbol bounding box.
void	Draw (eVision.EDrawAdapter graphicContext)
	Draws the symbol bounding box.
void	Draw (IntPtr graphicContext, eVision.EDrawingMode drawingMode, bool daughters)
	Draws the symbol bounding box.
void	Draw (IntPtr graphicContext, eVision.EDrawingMode drawingMode)
	Draws the symbol bounding box.
void	Draw (IntPtr graphicContext)
	Draws the symbol bounding box.
void	Draw (IntPtr graphicContext, eVision.ERGBColor color, eVision.EDrawingMode drawingMode, bool daughters)
	Draws the symbol bounding box.
void	Draw (IntPtr graphicContext, eVision.ERGBColor color, eVision.EDrawingMode drawingMode)
	Draws the symbol bounding box.
void	Draw (IntPtr graphicContext, eVision.ERGBColor color)
	Draws the symbol bounding box.
void	DrawWithCurrentPen (IntPtr graphicContext, eVision.EDrawingMode drawingMode, bool daughters)
	Draws the symbol bounding box.
void	DrawWithCurrentPen (IntPtr graphicContext, eVision.EDrawingMode drawingMode)
	Draws the symbol bounding box.
void	DrawWithCurrentPen (IntPtr graphicContext)
	Draws the symbol bounding box.
bool	HitTest (bool daughters)
	Checks whether the cursor is positioned over a handle (true) or not (false).
bool	HitTest ()
	Checks whether the cursor is positioned over a handle (true) or not (false).
void	Drag (int cursorX, int cursorY)
	Moves a handle to a new position and updates the position parameters of the symbol bounding box.
void	SetSize (float sizeX, float sizeY)
	Sets the size of a EBarCode object.
void	SetCenterXY (float centerX, float centerY)
	Sets the center coordinates of a EBarCode object.
string	GetSymbologyName (eVision.ESymbologies symbology)
	Retrieves the name of given symbology as a string.
void	Save (string path, bool daughters)
	Loads an EBarCode.The given EBarCode must have been created for writing.
void	Save (string path)
	Loads an EBarCode.The given EBarCode must have been created for writing.
void	Save (eVision.ESerializer serializer, bool daughters)
	Loads an EBarCode.The given EBarCode must have been created for writing.
void	Save (eVision.ESerializer serializer)
	Loads an EBarCode.The given EBarCode must have been created for writing.
void	Load (string path, bool daughters)
	Loads an EBarCode.The given EBarCode must have been created for reading.
void	Load (string path)
	Loads an EBarCode.The given EBarCode must have been created for reading.
void	Load (eVision.ESerializer serializer, bool daughters)
	Loads an EBarCode.The given EBarCode must have been created for reading.
void	Load (eVision.ESerializer serializer)
	Loads an EBarCode.The given EBarCode must have been created for reading.
void	Draw (System.Drawing.Graphics graphicContext, eVision.EDrawingMode drawingMode, bool daughters)
	Draws the symbol bounding box.
void	Draw (System.Drawing.Graphics graphicContext, eVision.EDrawingMode drawingMode)
	Draws the symbol bounding box.
void	Draw (System.Drawing.Graphics graphicContext)
	Draws the symbol bounding box.
void	Draw (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, eVision.EDrawingMode drawingMode, bool daughters)
	Draws the symbol bounding box.
void	Draw (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, eVision.EDrawingMode drawingMode)
	Draws the symbol bounding box.
void	Draw (System.Drawing.Graphics graphicContext, eVision.ERGBColor color)
	Draws the symbol bounding box.

Properties
eVision.Legacy.ERectangle	Rectangle `[set]`
	Sets the nominal position (center coordinates), size and rotation angle of the symbol bounding box according to a known rectangle.
float	RelativeReadingX `[get]`
	Reading area abscissa, relative to the symbol position.
float	RelativeReadingY `[get]`
	Reading area ordinate, relative to the symbol position.
float	RelativeReadingSizeX `[get]`
	Reading area width, relative to the symbol extent.
float	RelativeReadingSizeY `[get]`
	Reading area height, relative to the symbol extent.
float	Module `[get, set]`
	Module value.
float	ThicknessRatio `[get, set]`
	Bars thickness ratio.
bool	KnownLocation `[get, set]`
	Flag indicating whether the symbol location is known or not.
bool	KnownModule `[get, set]`
	Flag indicating whether the symbol module is known or not.
bool	VerifyChecksum `[get, set]`
	"VerifyChecksum" mode.
uint	NumEnabledSymbologies `[get]`
	Number of enabled symbologies.
uint	NumDecodedSymbologies `[get]`
	Number of symbologies (among the enabled ones) for which the decoding process was successful.
uint	StandardSymbologies `[get, set]`
	Enabled symbologies belonging to the group of standard symbologies.
uint	AdditionalSymbologies `[get, set]`
	Enabled symbologies belonging to the group of additional symbologies.
float	CenterX `[get]`
	Abscissa of the origin point of the EBarCode.
float	CenterY `[get]`
	Ordinate of the origin point of the EBarCode.
eVision.EPoint	Center `[get, set]`
	Center point of the EBarCode.
float	SizeX `[get]`
	X size of the EBarCode.
float	SizeY `[get]`
	Y size of the EBarCode.
float	Angle `[get, set]`
	Orientation of the shape.
eVision.Legacy.ERectangleShape	RectangleShape `[get]`
	Get the rectangle shape associated with the EBarCode.

Detailed Description

Manages a complete context for the reading or verification of bar codes in EasyBarCode.

License(s): EasyBarCode

Deprecated

Deprecated, use EBarCodeReader instead.

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

Constructor & Destructor Documentation

◆ EBarCode()

eVision.EBarCode.EBarCode ( )

Creates an EBarCode.EBarCode object.

Member Function Documentation

◆ Decode()

string eVision.EBarCode.Decode ( eVision.ESymbologies symbology )

Provides the decoded information (or a reading error code) corresponding to the specified symbology.

Parameters

symbology Specified symbology, as defined by ESymbologies this symbology must have been enabled).

Before calling EBarCode.Decode, an EBarCode.Detect operation must have been performed. In case of the mono-symbology mode, or if only the most likely decoding matters, the EBarCode.Read method should be used.

◆ Detect()

void eVision.EBarCode.Detect ( eVision.EROIBW8 sourceImage )

Processes the image, reads the possible contents of the bar code corresponding to all enabled symbologies and rates their likeliness.

Parameters

sourceImage Pointer to the image containing the bar code.

Processing the image means finding the symbol (in case of automatic location mode) and retrieving its descriptive parameters. The decoded information corresponding to a specific symbology is provided by the decode function. The symbologies that were successfully decoded are ranked by decreasing likeliness (range 0 to NumDecodedSymbologies-1). In case of the mono-symbology mode or if only the most likely decoding matters, the Read function should be used.

◆ Drag()

void eVision.EBarCode.Drag	(	int	cursorX,
		int	cursorY )

Moves a handle to a new position and updates the position parameters of the symbol bounding box.

Parameters

cursorX	Cursor current coordinates.
cursorY	Cursor current coordinates.

◆ Draw() [1/15]

void eVision.EBarCode.Draw ( eVision.EDrawAdapter graphicContext )

Draws the symbol bounding box.

Parameters

graphicContext Handle of the device context on which to draw.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

◆ Draw() [2/15]

void eVision.EBarCode.Draw	(	eVision.EDrawAdapter	graphicContext,
		eVision.EDrawingMode	drawingMode )

Draws the symbol bounding box.

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the symbol bounding box must be displayed, as defined by EDrawingMode.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

◆ Draw() [3/15]

void eVision.EBarCode.Draw	(	eVision.EDrawAdapter	graphicContext,
		eVision.EDrawingMode	drawingMode,
		bool	daughters )

Draws the symbol bounding box.

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the symbol bounding box must be displayed, as defined by EDrawingMode.
daughters	true if the shapes attached to the symbol bounding box are to be displayed as well.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

◆ Draw() [4/15]

void eVision.EBarCode.Draw ( IntPtr graphicContext )

Draws the symbol bounding box.

Parameters

graphicContext Handle of the device context on which to draw.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

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() [5/15]

void eVision.EBarCode.Draw	(	IntPtr	graphicContext,
		eVision.EDrawingMode	drawingMode )

Draws the symbol bounding box.

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the symbol bounding box must be displayed, as defined by EDrawingMode.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

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() [6/15]

void eVision.EBarCode.Draw	(	IntPtr	graphicContext,
		eVision.EDrawingMode	drawingMode,
		bool	daughters )

Draws the symbol bounding box.

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the symbol bounding box must be displayed, as defined by EDrawingMode.
daughters	true if the shapes attached to the symbol bounding box are to be displayed as well.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

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/15]

void eVision.EBarCode.Draw	(	IntPtr	graphicContext,
		eVision.ERGBColor	color )

Draws the symbol bounding box.

Parameters

graphicContext	Handle of the device context on which to draw.
color	The color in which to draw the overlay.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

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/15]

void eVision.EBarCode.Draw	(	IntPtr	graphicContext,
		eVision.ERGBColor	color,
		eVision.EDrawingMode	drawingMode )

Draws the symbol bounding box.

Parameters

graphicContext	Handle of the device context on which to draw.
color	The color in which to draw the overlay.
drawingMode	Indicates how the symbol bounding box must be displayed, as defined by EDrawingMode.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

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/15]

void eVision.EBarCode.Draw	(	IntPtr	graphicContext,
		eVision.ERGBColor	color,
		eVision.EDrawingMode	drawingMode,
		bool	daughters )

Draws the symbol bounding box.

Parameters

graphicContext	Handle of the device context on which to draw.
color	The color in which to draw the overlay.
drawingMode	Indicates how the symbol bounding box must be displayed, as defined by EDrawingMode.
daughters	true if the shapes attached to the symbol bounding box are to be displayed as well.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

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/15]

void eVision.EBarCode.Draw ( System.Drawing.Graphics graphicContext )

Draws the symbol bounding box.

Parameters

graphicContext Handle of the device context on which to draw.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

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() [11/15]

void eVision.EBarCode.Draw	(	System.Drawing.Graphics	graphicContext,
		eVision.EDrawingMode	drawingMode )

Draws the symbol bounding box.

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the symbol bounding box must be displayed, as defined by EDrawingMode.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

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() [12/15]

void eVision.EBarCode.Draw	(	System.Drawing.Graphics	graphicContext,
		eVision.EDrawingMode	drawingMode,
		bool	daughters )

Draws the symbol bounding box.

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the symbol bounding box must be displayed, as defined by EDrawingMode.
daughters	true if the shapes attached to the symbol bounding box are to be displayed as well.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

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() [13/15]

void eVision.EBarCode.Draw	(	System.Drawing.Graphics	graphicContext,
		eVision.ERGBColor	color )

Draws the symbol bounding box.

Parameters

graphicContext	Handle of the device context on which to draw.
color	The color in which to draw the overlay.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

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() [14/15]

void eVision.EBarCode.Draw	(	System.Drawing.Graphics	graphicContext,
		eVision.ERGBColor	color,
		eVision.EDrawingMode	drawingMode )

Draws the symbol bounding box.

Parameters

graphicContext	Handle of the device context on which to draw.
color	The color in which to draw the overlay.
drawingMode	Indicates how the symbol bounding box must be displayed, as defined by EDrawingMode.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

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() [15/15]

void eVision.EBarCode.Draw	(	System.Drawing.Graphics	graphicContext,
		eVision.ERGBColor	color,
		eVision.EDrawingMode	drawingMode,
		bool	daughters )

Draws the symbol bounding box.

Parameters

graphicContext	Handle of the device context on which to draw.
color	The color in which to draw the overlay.
drawingMode	Indicates how the symbol bounding box must be displayed, as defined by EDrawingMode.
daughters	true if the shapes attached to the symbol bounding box are to be displayed as well.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

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.

◆ DrawWithCurrentPen() [1/3]

void eVision.EBarCode.DrawWithCurrentPen ( IntPtr graphicContext )

Draws the symbol bounding box.

Parameters

graphicContext Handle of the device context on which to draw.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

Deprecated

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

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

◆ DrawWithCurrentPen() [2/3]

void eVision.EBarCode.DrawWithCurrentPen	(	IntPtr	graphicContext,
		eVision.EDrawingMode	drawingMode )

Draws the symbol bounding box.

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the symbol bounding box must be displayed, as defined by EDrawingMode.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

Deprecated

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

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

◆ DrawWithCurrentPen() [3/3]

void eVision.EBarCode.DrawWithCurrentPen	(	IntPtr	graphicContext,
		eVision.EDrawingMode	drawingMode,
		bool	daughters )

Draws the symbol bounding box.

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the symbol bounding box must be displayed, as defined by EDrawingMode.
daughters	true if the shapes attached to the symbol bounding box are to be displayed as well.

The bounding box corresponds to the nominal position of the bar code (EDrawingMode.EDrawingMode_Nominal), in case this information has been explicitly provided, and to the actual position (EDrawingMode.EDrawingMode_Actual) if it has been determined by image analysis.

Deprecated

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

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

◆ GetDecodedAngle() [1/4]

void eVision.EBarCode.GetDecodedAngle	(	eVision.ESymbologies	symbology,
		out float	decodedAngle )

Allows retrieving the bar code reading angle, pertaining to the specified symbology, or, at least, to the most likely symbology.

Parameters

symbology	Specified symbology, as defined by ESymbologies (this symbology must have been enabled).
decodedAngle	Returned bar code reading angle value.

◆ GetDecodedAngle() [2/4]

void eVision.EBarCode.GetDecodedAngle	(	eVision.ESymbologies	symbology,
		out float	decodedAngle,
		float	cutAngle )

Allows retrieving the bar code reading angle, pertaining to the specified symbology, or, at least, to the most likely symbology.

Parameters

symbology	Specified symbology, as defined by ESymbologies (this symbology must have been enabled).
decodedAngle	Returned bar code reading angle value.
cutAngle	Cut angle value (degrees) defining the allowed range for the bar code reading angle ([cutAngle, cutAngle + 360]). By default, the cut angle equals -45.

◆ GetDecodedAngle() [3/4]

void eVision.EBarCode.GetDecodedAngle ( out float decodedAngle )

Allows retrieving the bar code reading angle, pertaining to the specified symbology, or, at least, to the most likely symbology.

Parameters

decodedAngle Returned bar code reading angle value.

◆ GetDecodedAngle() [4/4]

void eVision.EBarCode.GetDecodedAngle	(	out float	decodedAngle,
		float	cutAngle )

Allows retrieving the bar code reading angle, pertaining to the specified symbology, or, at least, to the most likely symbology.

Parameters

decodedAngle	Returned bar code reading angle value.
cutAngle	Cut angle value (degrees) defining the allowed range for the bar code reading angle ([cutAngle, cutAngle + 360]). By default, the cut angle equals -45.

◆ GetDecodedDirection() [1/2]

void eVision.EBarCode.GetDecodedDirection	(	eVision.ESymbologies	symbology,
		out bool	directEncoding )

Returns the encoding direction of the bar code, pertaining to the specified symbology, or, at least, to the most likely symbology.

Parameters

symbology	Specified symbology, as defined by ESymbologies (this symbology must have been enabled).
directEncoding	Boolean holding the encoding direction status.

The encoding direction of the bar code is "Direct" or "Inverse". The encoding direction is said to be "Direct" when the bar code longitudinal axis falls in the range [-45 degrees, 135]. Conversely, when the bar code longitudinal axis doesn't fall in the previous range, the encoding direction is said to be "Inverse".

◆ GetDecodedDirection() [2/2]

void eVision.EBarCode.GetDecodedDirection ( out bool directEncoding )

Returns the encoding direction of the bar code, pertaining to the specified symbology, or, at least, to the most likely symbology.

Parameters

directEncoding Boolean holding the encoding direction status.

The encoding direction of the bar code is "Direct" or "Inverse". The encoding direction is said to be "Direct" when the bar code longitudinal axis falls in the range [-45 degrees, 135]. Conversely, when the bar code longitudinal axis doesn't fall in the previous range, the encoding direction is said to be "Inverse".

◆ GetDecodedRectangle() [1/2]

void eVision.EBarCode.GetDecodedRectangle	(	eVision.ESymbologies	symbology,
		eVision.Legacy.ERectangle	rect )

Allows retrieving the bar code reading rectangle, pertaining to the specified symbology, or, at least, to the most likely symbology.

Parameters

symbology	Specified symbology, as defined by ESymbologies (this symbology must have been enabled).
rect	Returned bar code reading rectangle.

◆ GetDecodedRectangle() [2/2]

void eVision.EBarCode.GetDecodedRectangle ( eVision.Legacy.ERectangle rect )

Allows retrieving the bar code reading rectangle, pertaining to the specified symbology, or, at least, to the most likely symbology.

Parameters

rect	Returned bar code reading rectangle.

◆ GetDecodedSymbology()

eVision.ESymbologies eVision.EBarCode.GetDecodedSymbology ( uint index )

Returns the identifier of one of the symbologies that were successfully decoded.

Parameters

index Index of the specified symbology (range 0 to NumDecodedSymbologies-1).

The desired symbology is specified by its ranking index (range 0 to NumDecodedSymbologies-1). The symbologies that were successfully decoded are ranked by decreasing likeliness.

◆ GetSymbologyName()

string eVision.EBarCode.GetSymbologyName ( eVision.ESymbologies symbology )

Retrieves the name of given symbology as a string.

Parameters

symbology Symbology.

◆ HitTest() [1/2]

bool eVision.EBarCode.HitTest ( )

Checks whether the cursor is positioned over a handle (true) or not (false).

◆ HitTest() [2/2]

bool eVision.EBarCode.HitTest ( bool daughters )

Checks whether the cursor is positioned over a handle (true) or not (false).

Parameters

daughters true if the handles of the shapes attached to the symbol bounding box have to be considered as well.

◆ Load() [1/4]

void eVision.EBarCode.Load ( eVision.ESerializer serializer )

Loads an EBarCode.The given EBarCode must have been created for reading.

Parameters

serializer Pointer to the ESerializer created for reading.

◆ Load() [2/4]

void eVision.EBarCode.Load	(	eVision.ESerializer	serializer,
		bool	daughters )

Loads an EBarCode.The given EBarCode must have been created for reading.

Parameters

serializer	Pointer to the ESerializer created for reading.
daughters	Indicates if the load must be done on the whole hierarchy or just this object.

◆ Load() [3/4]

void eVision.EBarCode.Load ( string path )

Loads an EBarCode.The given EBarCode must have been created for reading.

Parameters

path	The file path.

◆ Load() [4/4]

void eVision.EBarCode.Load	(	string	path,
		bool	daughters )

Loads an EBarCode.The given EBarCode must have been created for reading.

Parameters

path	The file path.
daughters	Indicates if the load must be done on the whole hierarchy or just this object.

◆ Read()

string eVision.EBarCode.Read ( eVision.EROIBW8 sourceImage )

Processes the image, reads the possible contents of the bar code and returns the single possible decoding (mono-symbology) or the most likely one (multi-symbology) or a reading error code.

Parameters

sourceImage The image containing the bar code.

Processing the image means finding the symbol (in case of automatic location mode) and retrieving its descriptive parameters. When decoding other than the most likely one are also required, a call to the EBarCode.Detect function followed by a EBarCode.Decode should be used.

◆ Save() [1/4]

void eVision.EBarCode.Save ( eVision.ESerializer serializer )

Loads an EBarCode.The given EBarCode must have been created for writing.

Parameters

serializer Pointer to the ESerializer created for writing.

◆ Save() [2/4]

void eVision.EBarCode.Save	(	eVision.ESerializer	serializer,
		bool	daughters )

Loads an EBarCode.The given EBarCode must have been created for writing.

Parameters

serializer	Pointer to the ESerializer created for writing.
daughters	Indicates if the save must be done on the whole hierarchy or just this object.

◆ Save() [3/4]

void eVision.EBarCode.Save ( string path )

Loads an EBarCode.The given EBarCode must have been created for writing.

Parameters

path	The file path.

◆ Save() [4/4]

void eVision.EBarCode.Save	(	string	path,
		bool	daughters )

Loads an EBarCode.The given EBarCode must have been created for writing.

Parameters

path	The file path.
daughters	Indicates if the save must be done on the whole hierarchy or just this object.

◆ SetCenterXY()

void eVision.EBarCode.SetCenterXY	(	float	centerX,
		float	centerY )

Sets the center coordinates of a EBarCode object.

Parameters

centerX	Center coordinates of the EBarCode object.
centerY	Center coordinates of the EBarCode object.

◆ SetReadingCenter()

void eVision.EBarCode.SetReadingCenter	(	float	relativeX,
		float	relativeY )

Sets the reading area center coordinates, relative to the symbol position and extent.

Parameters

relativeX	Reading area center abscissa, relative to the symbol position and extent.
relativeY	Reading area center ordinate, relative to the symbol position and extent.

◆ SetReadingSize()

void eVision.EBarCode.SetReadingSize	(	float	relativeSizeX,
		float	relativeSizeY )

Sets the reading area size, relative to the symbol extent.

Parameters

relativeSizeX	Reading area width, relative to the symbol extent.
relativeSizeY	Reading area height, relative to the symbol extent.

◆ SetSize()

void eVision.EBarCode.SetSize	(	float	sizeX,
		float	sizeY )

Sets the size of a EBarCode object.

Parameters

sizeX	Nominal size X of the EBarCode object. Default values is 100.
sizeY	Nominal size Y of the EBarCode object. Default values is 100.

A EBarCode object is fully defined knowing its nominal position (given by the coordinates of its center), its nominal size, its rotation angle and its outline tolerance. By default, the width and height values are 100, which means 100 pixels when the field of view is not calibrated and 100 "units" in case of a calibrated field of view.

Property Documentation

◆ AdditionalSymbologies

uint eVision.EBarCode.AdditionalSymbologies

getset

Enabled symbologies belonging to the group of additional symbologies.

Due to the large number of supported symbologies, they have been gathered in two groups. For more information about these groups, see ESymbologies.

◆ Angle

float eVision.EBarCode.Angle

getset

Orientation of the shape.

◆ Center

eVision.EPoint eVision.EBarCode.Center

getset

Center point of the EBarCode.

◆ CenterX

float eVision.EBarCode.CenterX

get

Abscissa of the origin point of the EBarCode.

◆ CenterY

float eVision.EBarCode.CenterY

get

Ordinate of the origin point of the EBarCode.

◆ KnownLocation

bool eVision.EBarCode.KnownLocation

getset

Flag indicating whether the symbol location is known or not.

In case of known location, use EBarCode.Rectangle to adjust a rectangle around the symbol.

◆ KnownModule

bool eVision.EBarCode.KnownModule

getset

Flag indicating whether the symbol module is known or not.

If true, it is also necessary to get the EBarCode.Module and EBarCode.ThicknessRatio properties in order to specify the requested module and thickness ratio.

◆ Module

float eVision.EBarCode.Module

getset

Module value.

The module value is a descriptive parameter participating in the encoding; it corresponds to the thinner bar width. Symbols whose bars thickness can take two values, the module and V times the module (where V runs from 1.5 to 3), are called binary bar codes. When the bars thickness are small integer multiples (1 to 4 or 5) of a module, the symbols are called modular bar codes.

◆ NumDecodedSymbologies

uint eVision.EBarCode.NumDecodedSymbologies

get

Number of symbologies (among the enabled ones) for which the decoding process was successful.

◆ NumEnabledSymbologies

uint eVision.EBarCode.NumEnabledSymbologies

get

Number of enabled symbologies.

◆ Rectangle

eVision.Legacy.ERectangle eVision.EBarCode.Rectangle

set

Sets the nominal position (center coordinates), size and rotation angle of the symbol bounding box according to a known rectangle.

An ERectangle object is characterized by its center coordinates, its size and its rotation angle.

◆ RectangleShape

eVision.Legacy.ERectangleShape eVision.EBarCode.RectangleShape

get

Get the rectangle shape associated with the EBarCode.

◆ RelativeReadingSizeX

float eVision.EBarCode.RelativeReadingSizeX

get

Reading area width, relative to the symbol extent.

◆ RelativeReadingSizeY

float eVision.EBarCode.RelativeReadingSizeY

get

Reading area height, relative to the symbol extent.

◆ RelativeReadingX

float eVision.EBarCode.RelativeReadingX

get

Reading area abscissa, relative to the symbol position.

◆ RelativeReadingY

float eVision.EBarCode.RelativeReadingY

get

Reading area ordinate, relative to the symbol position.

◆ SizeX

float eVision.EBarCode.SizeX

get

X size of the EBarCode.

◆ SizeY

float eVision.EBarCode.SizeY

get

Y size of the EBarCode.

◆ StandardSymbologies

uint eVision.EBarCode.StandardSymbologies

getset

Enabled symbologies belonging to the group of standard symbologies.

Due to the large number of supported symbologies, they have been gathered in two groups. For more information about these groups, see ESymbologies.

◆ ThicknessRatio

float eVision.EBarCode.ThicknessRatio

getset

Bars thickness ratio.

This property is relevant in case of binary codes only. It corresponds to the ratio of a thin bar width over a thick bar width, and should range from 1.5 to 3.

◆ VerifyChecksum

bool eVision.EBarCode.VerifyChecksum

getset

"VerifyChecksum" mode.

The "VerifyChecksum" mode enables or disables verification of the checksum character. That verification mode is set in the same way for all enabled symbologies. It is worth noting that checksum may be present or not in the bar code, and the user may verify or not checksum validity. These two circumstances are independent, and give rise to four modes of operation. The verification process will return an "invalid checksum" error in case of bad checksum character. This error can also be generated if there is no checksum in the bar code. In the other case, when checksum are not verified, no error will occur, and the process will continue silently. When the "VerifyChecksum" mode is enabled, the returned decoded string does not contain the checksum character(s). Conversely, when the verification process is disabled, the checksum character(s) are concatenated to the encoded information.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ EBarCode()

Member Function Documentation

◆ Decode()

◆ Detect()

◆ Drag()

◆ Draw() [1/15]

◆ Draw() [2/15]

◆ Draw() [3/15]

◆ Draw() [4/15]

◆ Draw() [5/15]

◆ Draw() [6/15]

◆ Draw() [7/15]

◆ Draw() [8/15]

◆ Draw() [9/15]

◆ Draw() [10/15]

◆ Draw() [11/15]

◆ Draw() [12/15]

◆ Draw() [13/15]

◆ Draw() [14/15]

◆ Draw() [15/15]

◆ DrawWithCurrentPen() [1/3]

◆ DrawWithCurrentPen() [2/3]

◆ DrawWithCurrentPen() [3/3]

◆ GetDecodedAngle() [1/4]

◆ GetDecodedAngle() [2/4]

◆ GetDecodedAngle() [3/4]

◆ GetDecodedAngle() [4/4]

◆ GetDecodedDirection() [1/2]

◆ GetDecodedDirection() [2/2]

◆ GetDecodedRectangle() [1/2]

◆ GetDecodedRectangle() [2/2]

◆ GetDecodedSymbology()

◆ GetSymbologyName()

◆ HitTest() [1/2]

◆ HitTest() [2/2]

◆ Load() [1/4]

◆ Load() [2/4]

◆ Load() [3/4]

◆ Load() [4/4]

◆ Read()

◆ Save() [1/4]

◆ Save() [2/4]

◆ Save() [3/4]

◆ Save() [4/4]

◆ SetCenterXY()

◆ SetReadingCenter()

◆ SetReadingSize()

◆ SetSize()

Property Documentation

◆ AdditionalSymbologies

◆ Angle

◆ Center

◆ CenterX

◆ CenterY

◆ KnownLocation

◆ KnownModule

◆ Module

◆ NumDecodedSymbologies

◆ NumEnabledSymbologies

◆ Rectangle

◆ RectangleShape

◆ RelativeReadingSizeX

◆ RelativeReadingSizeY

◆ RelativeReadingX

◆ RelativeReadingY

◆ SizeX

◆ SizeY

◆ StandardSymbologies

◆ ThicknessRatio

◆ VerifyChecksum