UniPRT SDK v2.0.0.0
 
Loading...
Searching...
No Matches
LabelMaker.TSPL.Pdf417Barcode.Pdf417Barcode Class Reference

A class representing a PDF417 barcode for TSPL. More...

Inheritance diagram for LabelMaker.TSPL.Pdf417Barcode.Pdf417Barcode:
LabelMaker.Interfaces.IBcdPdf417.APdf417 LabelMaker.Interfaces.IBarcode2D.ABarcode2D LabelMaker.Interfaces.IBarcode2D.IRectangleCell LabelMaker.Interfaces.IBarcode2D.IBarcode2D LabelMaker.Interfaces.IBarcode2D.IBarcodeItem2D LabelMaker.Interfaces.IBarcode2D.IPositionRuler LabelMaker.Interfaces.ISettings.IRotation

Public Member Functions

 __init__ (self, Optional[IPoint] start=None, Optional[str] data=None)
 Initializes a new instance of the Pdf417Barcode class.
 
str __str__ (self)
 Returns a string that can be sent to the printer.
 
 limit_range (self, value, minimum, maximum)
 Limits the range of a value to a specified minimum and maximum.
 
- Public Member Functions inherited from LabelMaker.Interfaces.IBcdPdf417.APdf417
 __init__ (self, IPoint start, str data)
 Initializes a PDF417 barcode with a start point and data.
 
- Public Member Functions inherited from LabelMaker.Interfaces.IBarcode2D.ABarcode2D
 __init__ (self, Optional[IPoint] start=None, str data="", Optional[IRuler] ruler=None, RotateEnum rotation=RotateEnum.NONE)
 
str __str__ (self)
 
- Public Member Functions inherited from LabelMaker.Interfaces.IBarcode2D.IBarcode2D
str __str__ (self)
 

Additional Inherited Members

- Public Attributes inherited from LabelMaker.Interfaces.IBcdPdf417.APdf417
 cell_size = None
 
 error_correction = Pdf417ErrCorrectionEnum.LEVEL2
 
int rows = 0
 
int columns = 0
 
- Public Attributes inherited from LabelMaker.Interfaces.IBarcode2D.ABarcode2D
 start = start
 
 data = data
 
 ruler = ruler or Defaults.ruler()
 
 rotation = rotation
 

Detailed Description

A class representing a PDF417 barcode for TSPL.

This class inherits from APdf417 and provides functionality for initializing and describing PDF417 barcodes in TSPL.

Constructor & Destructor Documentation

◆ __init__()

LabelMaker.TSPL.Pdf417Barcode.Pdf417Barcode.__init__ ( self,
Optional[IPoint] start = None,
Optional[str] data = None )

Initializes a new instance of the Pdf417Barcode class.

Parameters
startThe starting point of the barcode.
dataThe data to be encoded in the barcode.

Member Function Documentation

◆ __str__()

str LabelMaker.TSPL.Pdf417Barcode.Pdf417Barcode.__str__ ( self)

Returns a string that can be sent to the printer.

This method generates a string representation of the Pdf417Barcode instance that is formatted and ready to be sent to a printer. The string includes all the necessary commands and data required for printing in TSPL.

Returns
A string description of the Pdf417Barcode instance.

◆ limit_range()

LabelMaker.TSPL.Pdf417Barcode.Pdf417Barcode.limit_range ( self,
value,
minimum,
maximum )

Limits the range of a value to a specified minimum and maximum.

This method ensures that the provided value stays within the defined range by returning the minimum if the value is below it, the maximum if above it, or the value itself if it is within range.

Parameters
valueThe value to be limited.
minimumThe minimum allowable value.
maximumThe maximum allowable value.
Returns
Returns the value limited within the minimum and maximum range.

Reimplemented from LabelMaker.Interfaces.IBcdPdf417.APdf417.


The documentation for this class was generated from the following file: