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

Configuration class for Australia Post. More...

#include <cvb/config.hpp>

Inherits ConfigBase< AustraliaPost >.

Public Member Functions

AustraliaPostSetStripCheckCharactersEnabled (bool value)
 Enables or disables the removal of check characters from decoded data.
 
bool IsStripCheckCharactersEnabled () const
 Checks whether the removal of check characters from decoded data is enabled.
 
- Public Member Functions inherited from ConfigBase< AustraliaPost >
bool Enabled () const
 Checks if decoding for the code type represented by the derived class is enabled.
 
AustraliaPostEnable ()
 Enables decoding for the code type represented by the derived class.
 
AustraliaPostDisable ()
 Disables decoding for the code type represented by the derived class.
 

Friends

class Cvb::CodeReader::Decoder
 

Detailed Description

Configuration class for Australia Post.

Use this class to configure decoding options for Australia Post codes. To access the configuration and enable decoding Australia Post codes, use the following example. For additional details on configuration, refer to the documentation for Decoder::Config().

AustraliaPost & 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
@ AustraliaPost
Australia Post.
Definition decl_config_base.hpp:122
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

◆ IsStripCheckCharactersEnabled()

bool IsStripCheckCharactersEnabled ( ) const
inline

Checks whether the removal of check characters from decoded data is enabled.

Returns
true if the removal of check characters from decoded data is enabled, false otherwise.

◆ SetStripCheckCharactersEnabled()

AustraliaPost & SetStripCheckCharactersEnabled ( bool value)
inline

Enables or disables the removal of check characters from decoded data.

Parameters
valueSet to true to enable the removal of check characters, or false to disable it.
Returns
A reference to the current AustraliaPost object for method chaining.