GS1 Barcode Syntax Engine — C / C++ API
Library for processing GS1 Application Identifier syntax
Data Structures | Enumerations
gs1encoders Namespace Reference

Namespace containing the C++ wrapper for the GS1 Barcode Syntax Engine. More...

Data Structures

class  GS1Encoder
 Main class for processing GS1 barcode data, including validation, format conversion, and generation of outputs such as GS1 Digital Link URIs and Human-Readable Interpretation text. More...
 
class  GS1EncoderDigitalLinkException
 Thrown to indicate an error processing GS1 Digital Link data. More...
 
class  GS1EncoderException
 Common base class for all exceptions thrown by this wrapper. More...
 
class  GS1EncoderGeneralException
 Thrown to indicate a general problem initialising the library, such as when the underlying AI table cannot be loaded. More...
 
class  GS1EncoderParameterException
 Thrown to indicate a problem with the parameters or input data passed to a setter. When the failure is a linting failure on AI data, gs1encoders::GS1Encoder::err_markup() returns a marked-up rendering of the offending AI. More...
 
class  GS1EncoderScanDataException
 Thrown to indicate an error processing barcode scan data. More...
 
struct  InitOpts
 Initialisation options for the gs1encoders::GS1Encoder constructor. More...
 

Enumerations

enum class  Symbology : int {
  Symbology::None = gs1_encoder_sNONE , Symbology::DataBarOmni = gs1_encoder_sDataBarOmni , Symbology::DataBarTruncated = gs1_encoder_sDataBarTruncated , Symbology::DataBarStacked = gs1_encoder_sDataBarStacked ,
  Symbology::DataBarStackedOmni = gs1_encoder_sDataBarStackedOmni , Symbology::DataBarLimited = gs1_encoder_sDataBarLimited , Symbology::DataBarExpanded = gs1_encoder_sDataBarExpanded , Symbology::UPCA = gs1_encoder_sUPCA ,
  Symbology::UPCE = gs1_encoder_sUPCE , Symbology::EAN13 = gs1_encoder_sEAN13 , Symbology::EAN8 = gs1_encoder_sEAN8 , Symbology::GS1_128_CCA = gs1_encoder_sGS1_128_CCA ,
  Symbology::GS1_128_CCC = gs1_encoder_sGS1_128_CCC , Symbology::QR = gs1_encoder_sQR , Symbology::DM = gs1_encoder_sDM , Symbology::DotCode = gs1_encoder_sDotCode ,
  Symbology::NumSyms = gs1_encoder_sNUMSYMS
}
 Recognised GS1 barcode formats ("symbologies") for processing scan data. More...
 
enum class  Validation : int {
  Validation::MutexAIs = gs1_encoder_vMUTEX_AIS , Validation::RequisiteAIs = gs1_encoder_vREQUISITE_AIS , Validation::RepeatedAIs = gs1_encoder_vREPEATED_AIS , Validation::DigSigSerialKey = gs1_encoder_vDIGSIG_SERIAL_KEY ,
  Validation::UnknownAInotDLattr = gs1_encoder_vUNKNOWN_AI_NOT_DL_ATTR , Validation::NumValidations = gs1_encoder_vNUMVALIDATIONS
}
 Optional AI validation procedures that may be applied to detect invalid inputs. More...
 

Detailed Description

Namespace containing the C++ wrapper for the GS1 Barcode Syntax Engine.