UniPRT SDK v1.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 Attributes

 start
 
 data
 
 error_correction
 
 columns
 
 rows
 
 rotation
 
- Public Attributes inherited from LabelMaker.Interfaces.IBcdPdf417.APdf417
 start
 
 data
 
 cell_size
 
 error_correction
 
 rows
 
 columns
 
- Public Attributes inherited from LabelMaker.Interfaces.IBarcode2D.ABarcode2D
 start
 
 data
 
 ruler
 
 rotation
 

Additional Inherited Members

- Static Public Attributes inherited from LabelMaker.Interfaces.IBcdPdf417.APdf417
IPoint start
 
str data
 
ICellRect cell_size
 
Pdf417ErrCorrectionEnum error_correction
 
int rows
 
int columns
 
- Static Public Attributes inherited from LabelMaker.Interfaces.IBarcode2D.IBarcodeItem2D
IPoint start
 
str data
 
- Static Public Attributes inherited from LabelMaker.Interfaces.IBarcode2D.IPositionRuler
IRuler ruler
 
- Static Public Attributes inherited from LabelMaker.Interfaces.ISettings.IRotation
RotateEnum rotation
 
- Static Public Attributes inherited from LabelMaker.Interfaces.IBarcode2D.IRectangleCell
ICellRect cell_size
 

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.

Reimplemented from LabelMaker.Interfaces.IBcdPdf417.APdf417.

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.

Reimplemented from LabelMaker.Interfaces.IBarcode2D.ABarcode2D.

◆ 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.

Member Data Documentation

◆ columns

LabelMaker.TSPL.Pdf417Barcode.Pdf417Barcode.columns

◆ data

LabelMaker.TSPL.Pdf417Barcode.Pdf417Barcode.data

◆ error_correction

LabelMaker.TSPL.Pdf417Barcode.Pdf417Barcode.error_correction

◆ rotation

LabelMaker.TSPL.Pdf417Barcode.Pdf417Barcode.rotation

◆ rows

LabelMaker.TSPL.Pdf417Barcode.Pdf417Barcode.rows

◆ start

LabelMaker.TSPL.Pdf417Barcode.Pdf417Barcode.start

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