Planet Class Reference

Configuration to access parameters of Planet. More...

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

Inherits ReaderPlanetPostnetConfigBase.

Public Member Functions
void	SetLevels (PlanetLevels levels)
	Specifies the levels for the allowed code types. More...
PlanetLevels	Levels () const
	Returns the levels for the allowed code types. More...
Public Member Functions inherited from ReaderPlanetPostnetConfigBase
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...

Static Public Member Functions
static std::unique_ptr< Planet >	FromHandle (const HandleGuard< ReaderConfig > &guard, bool &isActiveOut)
	Create object from handle. More...

Detailed Description

Configuration to access parameters of Planet.

Member Function Documentation

FromHandle()

static std::unique_ptr< Planet > FromHandle ( const HandleGuard< ReaderConfig > &  guard, bool &  isActiveOut  )

inlinestatic

Create object from handle.

Parameters

[in]	guard	Handle guard to read the configuration from.
[out]	isActiveOut	Returns the active state of the configuration in the handle.

Returns

unique pointer to object.

Exceptions

Any	exception derived from std::exception including CvbException.

Levels()

PlanetLevels Levels ( ) const

inline

Returns the levels for the allowed code types.

Returns

The types could be combined with a bitwise OR

Exceptions

Any	exception derived from std::exception including CvbException.

See also

SetLevels

SetLevels()

void SetLevels ( PlanetLevels  levels )

inline

Specifies the levels for the allowed code types.

Parameters

[in]

levels

The types could be combined with a bitwise OR

Exceptions

Any	exception derived from std::exception including CvbException.

See also

Levels