CVB++ 14.0
Rss Class Reference

Configuration to access parameters of Rss. More...

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

Inherits Reader2DConfigBase.

Public Member Functions

void SetComposition (RssComposition composition)
 Sets the bit field which specifies the permitted RSS composite components. More...
 
RssComposition Composition () const
 Returns the bit field which specifies the permitted RSS composite components. More...
 
void SetOrientation (CodeOrientation orientation)
 Selects the possible orientations in which the RSS code may occur. More...
 
CodeOrientation Orientation () const
 Returns the possible orientations in which the RSS code may occur. More...
 
void SetTypes (RssTypes types)
 Sets the RSS types. More...
 
RssTypes Types () const
 Returns the RSS types. More...
 
- Public Member Functions inherited from Reader2DConfigBase
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...
 
- 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< RssFromHandle (const HandleGuard< ReaderConfig > &guard, bool &isActiveOut)
 Create object from handle. More...
 

Detailed Description

Configuration to access parameters of Rss.

Member Function Documentation

◆ Composition()

RssComposition Composition ( ) const
inline

Returns the bit field which specifies the permitted RSS composite components.

Returns
The return value specifies the permitted RSS composite components. You can use a bitwise OR combination of the constants RssComposition::None, RssComposition::CCA, and RssComposition::CCB to permit any required combination. If no flags shall be used, set the parameter to RssComposition::Off, and if all flags shall be used, you can set the parameter to RssComposition::All. The default parameter is RssComposition::All.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetComposition

◆ FromHandle()

static std::unique_ptr< Rss > 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.

◆ Orientation()

CodeOrientation Orientation ( ) const
inline

Returns the possible orientations in which the RSS code may occur.

Returns
The parameter direction sets the orientations in which the RSS Code may occur. The default parameter is CodeOrientation::FenceOrLadder.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetOrientation

◆ SetComposition()

void SetComposition ( RssComposition  composition)
inline

Sets the bit field which specifies the permitted RSS composite components.

Parameters
[in]compositionIt specifies the permitted RSS composite components. You can use a bitwise OR combination of the constants RssComposition::None, RssComposition::CCA, and RssComposition::CCB to permit any required combination. If no flags shall be used, set the parameter to RssComposition::Off, and if all flags shall be used, you can set the parameter to RssComposition::All. The default parameter is RssComposition::All.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
Composition

◆ SetOrientation()

void SetOrientation ( CodeOrientation  orientation)
inline

Selects the possible orientations in which the RSS code may occur.

Parameters
[in]orientationIt sets the orientation, in which the RSS code may occur. The default parameter CodeOrientation::FenceOrLadder.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
Orientation

◆ SetTypes()

void SetTypes ( RssTypes  types)
inline

Sets the RSS types.

Parameters
[in]typesWith this parameter you can select the different subtypes of the RSS code, which shall decoded. Set the parameter to RssTypes::All to decode all supported RSS subtypes. Furthermore, you can use a bitwise OR combination of the constants RssTypes::Rss14, RssTypes::Rss14Truncated, RssTypes::Rss14Stacked, RssTypes::Rss14StackedOmnidirectional, and RssTypes::Limited to permit any required combination of the possible subtypes for decoding. The default parameter is RssTypes::All.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
Types

◆ Types()

RssTypes Types ( ) const
inline

Returns the RSS types.

Returns
The RSS types.
Exceptions
Anyexception derived from std::exception including CvbException.
See also
SetTypes