Configuration to access parameters of ReaderPlanetPostnetConfigBase. More...

#include <cvb/barcode/_detail/reader_planet_postnet_config_base.hpp>

Inherited by Planet, and Postnet.

Public Member Functions
void	SetEvaluateCheckDigit (bool evalCheckDigit)
	Sets the evaluate/ignore check digit. More...

bool	EvaluateCheckDigit () const
	Returns the evaluate/ignore check digit. More...

void	SetMirrored (bool mirrored)
	Sets whether the code is mirrored/not mirrored. More...

bool	Mirrored () const
	Returns whether the code is mirrored/not mirrored. More...

void	SetOrientation (CodeOrientation orientation)
	Specifies the orientation of the code in the image. More...

CodeOrientation	Orientation () const
	Returns the orientation of the code in the image. More...

void	SetQuietzoneWidth (int quietzoneWidth)
	Sets the quiet zone in module width. Possible values ranging from 2 to 10. Normally, the value is 5. More...

int	QuietzoneWidth () const
	Returns the quiet zone in module width. Possible values ranging from 2 to 10. Normally, the value is 5. More...

void	SetThreshold (int threshold)
	Sets the threshold between bar and gap in the code. More...

int	Threshold () const
	Returns the threshold between bar and gap in the code. More...

void	SetTransmitCheckDigit (bool transmitCheckDigit)
	Append/do not append check digit to data. More...

bool	TransmitCheckDigit () const
	Returns whether to append check digit to data. More...

Public Member Functions inherited from ReaderConfigBase
void	SetInverse (bool inverse)
	Code is inverted (white on black)/not inverted. More...

bool	Inverse () const
	Returns whether the code is inverted (white on black) or not. More...

Detailed Description

Configuration to access parameters of ReaderPlanetPostnetConfigBase.

Member Function Documentation

◆ EvaluateCheckDigit()

bool EvaluateCheckDigit ( ) const

inline

Returns the evaluate/ignore check digit.

Returns: The check digit value. Specifying true activates checking; specifying false deactivates checking.

Exceptions

Any	exception derived from std::exception including CvbException.

See also: SetEvaluateCheckDigit

◆ Mirrored()

bool Mirrored ( ) const

inline

Returns whether the code is mirrored/not mirrored.

Returns: Code is mirrored/not mirrored.

Exceptions

Any	exception derived from std::exception including CvbException.

See also: SetMirrored

◆ Orientation()

CodeOrientation Orientation ( ) const

inline

Returns the orientation of the code in the image.

Returns: The orientation of the barcode. It may be present in either vertical or horizontal orientation, but not in an angle of rotation of 20 degrees

Exceptions

Any	exception derived from std::exception including CvbException.

See also: SetOrientation

◆ QuietzoneWidth()

int QuietzoneWidth ( ) const

inline

Returns the quiet zone in module width. Possible values ranging from 2 to 10. Normally, the value is 5.

Returns: The quiet zone in module width. Possible values ranging from 2 to 10. Normally, the value is 5.

Exceptions

Any	exception derived from std::exception including CvbException.

See also: SetQuietzoneWidth

◆ SetEvaluateCheckDigit()

void SetEvaluateCheckDigit ( bool evalCheckDigit )

inline

Sets the evaluate/ignore check digit.

Parameters

[in] evalCheckDigit It activates or deactivates the checking of any check digit which may be present. Specifying true activates checking; specifying false deactivates checking.

Exceptions

Any	exception derived from std::exception including CvbException.

See also: EvaluateCheckDigit

◆ SetMirrored()

void SetMirrored ( bool mirrored )

inline

Sets whether the code is mirrored/not mirrored.

Parameters

[in] mirrored Code is mirrored/not mirrored.

Exceptions

Any	exception derived from std::exception including CvbException.

See also: Mirrored

◆ SetOrientation()

void SetOrientation ( CodeOrientation orientation )

inline

Specifies the orientation of the code in the image.

Parameters

[in] orientation The barcode may be present in either vertical or horizontal orientation, but not in an angle of rotation of 20 degrees.

Exceptions

Any	exception derived from std::exception including CvbException.

See also: Orientation

◆ SetQuietzoneWidth()

void SetQuietzoneWidth ( int quietzoneWidth )

inline

Sets the quiet zone in module width. Possible values ranging from 2 to 10. Normally, the value is 5.

Parameters

[in] quietzoneWidth Quiet zone in module width. Possible values ranging from 2 to 10. Normally, the value is 5.

Exceptions

Any	exception derived from std::exception including CvbException.

See also: QuietzoneWidth

◆ SetThreshold()

void SetThreshold ( int threshold )

inline

Sets the threshold between bar and gap in the code.

Parameters

[in] threshold Threshold between bar and gap in the code. Values ranges from 10 to 90 (%).

Exceptions

Any	exception derived from std::exception including CvbException.

See also: Threshold

◆ SetTransmitCheckDigit()

void SetTransmitCheckDigit ( bool transmitCheckDigit )

inline

Append/do not append check digit to data.

Parameters

[in] transmitCheckDigit If necessary, the transmit_checkdigit parameter activates or deactivates transmission of a check digit. Specifying true activates transmission; specifying false deactivates it. If transmitCheckDigit = false, this parameter is ignored.

Exceptions

Any	exception derived from std::exception including CvbException.

See also: TransmitCheckDigit

◆ Threshold()

int Threshold ( ) const

inline

Returns the threshold between bar and gap in the code.

Returns: Threshold between bar and gap in the code. Values ranges from 10 to 90 (%).

Exceptions

Any	exception derived from std::exception including CvbException.

See also: SetThreshold

◆ TransmitCheckDigit()

bool TransmitCheckDigit ( ) const

inline

Returns whether to append check digit to data.

Returns: The return value tells whether it activates or deactivates transmission of a check digit.

Exceptions

Any	exception derived from std::exception including CvbException.

See also: SetTransmitCheckDigit

Public Member Functions

Detailed Description

Member Function Documentation

◆ EvaluateCheckDigit()

◆ Mirrored()

◆ Orientation()

◆ QuietzoneWidth()

◆ SetEvaluateCheckDigit()

◆ SetMirrored()

◆ SetOrientation()

◆ SetQuietzoneWidth()

◆ SetThreshold()

◆ SetTransmitCheckDigit()

◆ Threshold()

◆ TransmitCheckDigit()