CVB++ 14.0
PharmaCode Class Reference

Configuration to access parameters of PharmaCode. More...

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

Inherits ReaderConfigBase.

Public Member Functions

void SetDirection (PharmaCodeRunDirection direction)
 Sets the run-direction in which the Pharmacode moves in the camera picture. More...
 
PharmaCodeRunDirection Direction () const
 Returns the run-direction in which the Pharmacode moves in the camera picture. More...
 
void SetMaxDigits (int maxDigits)
 Sets the maximum number of Pharmacode code words. More...
 
int MaxDigits () const
 Returns the maximum number of Pharmacode code words. More...
 
void SetMinDigits (int minDigits)
 Sets the minimum number of Pharmacode code words. More...
 
int MinDigits () const
 Returns the minimum number of Pharmacode code words. More...
 
void SetPixelReference (int pixelRef)
 Sets the illustration measure of the camera in a 10th of a pixel per millimetre. More...
 
int PixelReference () const
 Returns the illustration measure of the camera in a 10th of a pixel per millimetre. More...
 
void SetQuietzoneWidth (int quietzoneWidth)
 Sets the minimal quiet zone in a 10th of a millimetre. More...
 
int QuietzoneWidth () const
 Returns the minimal quiet zone in a 10th of a millimetre. More...
 
void SetScaleFactor (int scaleFactor)
 Sets the scale factor of the Pharmacode in percent. More...
 
int ScaleFactor () const
 Returns the scale factor of the Pharmacode in %. More...
 
void SetThreshold (int threshold)
 Sets the digitalisation threshold in percent ranging from 0 to 100 (default 10). More...
 
int Threshold () const
 Returns the digitalisation threshold in percent ranging from 0 to 100 (default 10). 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< PharmaCodeFromHandle (const HandleGuard< ReaderConfig > &guard, bool &isActiveOut)
 Create object from handle. More...
 

Detailed Description

Configuration to access parameters of PharmaCode.

Member Function Documentation

◆ Direction()

PharmaCodeRunDirection Direction ( ) const
inline

Returns the run-direction in which the Pharmacode moves in the camera picture.

Returns
Run-direction in which the Pharmacode moves in the camera picture.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetDirection

◆ FromHandle()

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

Create object from handle.

Parameters
[in]guardHandle guard to read the configuration from.
[out]isActiveOutReturns the active state of the configuration in the handle.
Returns
unique pointer to object.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ MaxDigits()

int MaxDigits ( ) const
inline

Returns the maximum number of Pharmacode code words.

Returns
The maximum number of Pharmacode code words.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetMaxDigits

◆ MinDigits()

int MinDigits ( ) const
inline

Returns the minimum number of Pharmacode code words.

Returns
The minimum number of Pharmacode code words.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetMinDigits

◆ PixelReference()

int PixelReference ( ) const
inline

Returns the illustration measure of the camera in a 10th of a pixel per millimetre.

Returns
The pixel reference.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetPixelReference

◆ QuietzoneWidth()

int QuietzoneWidth ( ) const
inline

Returns the minimal quiet zone in a 10th of a millimetre.

Returns
The minimal quiet zone
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetQuietzoneWidth

◆ ScaleFactor()

int ScaleFactor ( ) const
inline

Returns the scale factor of the Pharmacode in %.

Returns
The scale factor. Possible values are 50 to 200 (default 100). 100% = standard Pharmacode. 66% = miniature Pharmacode.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetScaleFactor

◆ SetDirection()

void SetDirection ( PharmaCodeRunDirection  direction)
inline

Sets the run-direction in which the Pharmacode moves in the camera picture.

Parameters
[in]directionRun-direction in which the Pharmacode moves in the camera picture.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
Direction

◆ SetMaxDigits()

void SetMaxDigits ( int  maxDigits)
inline

Sets the maximum number of Pharmacode code words.

Parameters
[in]maxDigitsThe parameters MinDigits() and maxDigits limit the number of code words for the Pharmacode. The parameter MinDigits() is in the range 2 to 16 (default 4). The parameter maxDigits is in the range 2 to 16 (default 16).
Exceptions
Anyexception derived from std::exception including CvbException.
See also
MaxDigits

◆ SetMinDigits()

void SetMinDigits ( int  minDigits)
inline

Sets the minimum number of Pharmacode code words.

Parameters
[in]minDigitsThe parameters minDigits and MaxDigits() limit the number of code words for the Pharmacode. The parameter minDigits is in the range 2 to 16 (default 4). The parameter MaxDigits() is in the range 2 to 16 (default 16).
Exceptions
Anyexception derived from std::exception including CvbException.
See also
MinDigits

◆ SetPixelReference()

void SetPixelReference ( int  pixelRef)
inline

Sets the illustration measure of the camera in a 10th of a pixel per millimetre.

Parameters
[in]pixelRefIt sets the illustration measure of the camera in 1/10 pixel per millimetre ranging from 0 to 1000 (default 30).
Exceptions
Anyexception derived from std::exception including CvbException.
See also
PixelReference

◆ SetQuietzoneWidth()

void SetQuietzoneWidth ( int  quietzoneWidth)
inline

Sets the minimal quiet zone in a 10th of a millimetre.

Parameters
[in]quietzoneWidthIt sets the minimal quiet zone in 1/10 mm. The range is 10 to 200 (default 50).
Exceptions
Anyexception derived from std::exception including CvbException.
See also
QuietzoneWidth

◆ SetScaleFactor()

void SetScaleFactor ( int  scaleFactor)
inline

Sets the scale factor of the Pharmacode in percent.

Parameters
[in]scaleFactorPossible values are 50 to 200 (default 100). 100% = standard Pharmacode. 66% = miniature Pharmacode.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
ScaleFactor

◆ SetThreshold()

void SetThreshold ( int  threshold)
inline

Sets the digitalisation threshold in percent ranging from 0 to 100 (default 10).

Parameters
[in]thresholdDigitalisation threshold in percent ranging from 0 to 100 (default 10).
Exceptions
Anyexception derived from std::exception including CvbException.
See also
Threshold

◆ Threshold()

int Threshold ( ) const
inline

Returns the digitalisation threshold in percent ranging from 0 to 100 (default 10).

Returns
The digitalisation threshold in percent ranging from 0 to 100 (default 10).
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetThreshold