RoyalMail Class Reference

Configuration class for RoyalMail 4-State codes. More...

#include <cvb/config.hpp>

Inherits ConfigBase< RoyalMail >.

Public Member Functions
RoyalMail &	SetSendCheckCharacterEnabled (bool value)
	Enables or disables adding check character to decoded data.
bool	IsSendCheckCharacterEnabled () const
	Checks whether adding check character to decoded data is enabled.
Public Member Functions inherited from ConfigBase< RoyalMail >
bool	Enabled () const
	Checks if decoding for the code type represented by the derived class is enabled.
RoyalMail &	Enable ()
	Enables decoding for the code type represented by the derived class.
RoyalMail &	Disable ()
	Disables decoding for the code type represented by the derived class.

Friends
class	Cvb::CodeReader::Decoder

Detailed Description

Configuration class for RoyalMail 4-State codes.

Use this class to configure decoding options for RoyalMail 4-State codes. To access the configuration and enable decoding Royal Mail codes, use the following example. For additional details on configuration, refer to the documentation for Decoder::Config().

auto decoder = Cvb::CodeReader::Decoder::Create();
decoder->Config<Cvb::CodeReader::Symbology::RoyalMail>().Enable();

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

IsSendCheckCharacterEnabled()

bool IsSendCheckCharacterEnabled ( ) const

inline

Checks whether adding check character to decoded data is enabled.

Returns

true if the adding check character is enabled, false otherwise.

SetSendCheckCharacterEnabled()

RoyalMail & SetSendCheckCharacterEnabled ( bool value )

inline

Enables or disables adding check character to decoded data.

Parameters

value

Set to true to enable adding check character to decoded data, or false to disable it.

Returns

A reference to the current RoyalMail object for method chaining.