CVB++ 15.0
Loading...
Searching...
No Matches
Interleaved2of5 Class Referencefinal

Configuration class for Interleaved 2 of 5 barcodes. More...

#include <cvb/config.hpp>

Inherits ConfigBase< Interleaved2of5 >.

Public Member Functions

Interleaved2of5SetMinDataLength (int length)
 Sets the minimum data length.
 
int MinDataLength () const
 Gets the minimum data length.
 
Interleaved2of5SetMaxDataLength (int length)
 Sets the maximum data length.
 
int MaxDataLength () const
 Gets the maximum data length.
 
Interleaved2of5SetChecksumEnabled (Checksum value)
 Configures checksum for decoding.
 
Checksum IsChecksumEnabled () const
 Gets checksum configuration.
 
Interleaved2of5SetRejectPartialEnabled (bool value)
 Enables or disables rejection of partial codes.
 
bool IsRejectPartialEnabled () const
 Checks whether rejection of partial codes is enabled.
 
- Public Member Functions inherited from ConfigBase< Interleaved2of5 >
bool Enabled () const
 Checks if decoding for the code type represented by the derived class is enabled.
 
Interleaved2of5Enable ()
 Enables decoding for the code type represented by the derived class.
 
Interleaved2of5Disable ()
 Disables decoding for the code type represented by the derived class.
 

Friends

class Cvb::CodeReader::Decoder
 

Detailed Description

Configuration class for Interleaved 2 of 5 barcodes.

Use this class to configure decoding options for Interleaved 2 of 5 barcodes. To access the configuration and enable decoding Interleaved 2 o f 5 barcodes, use the following example. For additional details on configuration, refer to the documentation for Decoder::Config().

Interleaved2of5 & Enable()
Definition detail_config_base.hpp:16
static std::unique_ptr< Decoder > Create()
Creates and returns a new Decoder instance.
Definition detail_decoder.hpp:22
@ Interleaved2of5
Interleaved 2 of 5.
Definition decl_config_base.hpp:92
Note
A more comprehensive code example demonstrating configuration in a broader context, as well as the decoding process, can be found here.

Member Function Documentation

◆ IsChecksumEnabled()

Checksum IsChecksumEnabled ( ) const
inline

Gets checksum configuration.

Returns
Value for checksum configuration.

◆ IsRejectPartialEnabled()

bool IsRejectPartialEnabled ( ) const
inline

Checks whether rejection of partial codes is enabled.

See function Interleaved2of5::SetEnableRejectPartial() for details.

Returns
value true if rejection of partial codes is enabled, false otherwise.

◆ MaxDataLength()

int MaxDataLength ( ) const
inline

Gets the maximum data length.

See function Interleaved2of5::SetMaxDataLength() for details.

Returns
Number of characters of the longest decoded string.

◆ MinDataLength()

int MinDataLength ( ) const
inline

Gets the minimum data length.

Returns
Number of characters of the shortest decoded string.

◆ SetChecksumEnabled()

Interleaved2of5 & SetChecksumEnabled ( Checksum value)
inline

Configures checksum for decoding.

Parameters
valueValue for checksum configuration.
Returns
A reference to the current Interleaved2of5 object for method chaining.

◆ SetMaxDataLength()

Interleaved2of5 & SetMaxDataLength ( int length)
inline

Sets the maximum data length.

The default value is 0 for no checking.

Parameters
lengthNumber of characters of the longest decoded string, up to 120.
Returns
A reference to the current Interleaved2of5 object for method chaining.

◆ SetMinDataLength()

Interleaved2of5 & SetMinDataLength ( int length)
inline

Sets the minimum data length.

Parameters
lengthNumber of characters of the shortest decoded string.
Returns
A reference to the current Interleaved2of5 object for method chaining.

◆ SetRejectPartialEnabled()

Interleaved2of5 & SetRejectPartialEnabled ( bool value)
inline

Enables or disables rejection of partial codes.

Enables or disables the rejection of partial Interleaved 2 of 5 codes. When this feature is enabled, the decoder becomes less likely to mistakenly decode a damaged or truncated code, such as when part of the code is missing due to its position in the image.

Parameters
valueSet to true to enable rejection of partial codes, or false to disable it.
Returns
A reference to the current Interleaved2of5 object for method chaining.