UniPRT SDK  v1.0.0.0
com.UniPRT.Sdk.LabelMaker.Interface.IMaxicodeMsgStructured Interface Reference

Maxicode barcode data. Maxicode Free Form carrier message. Only applies to Mode 2 and 3. More...

Inheritance diagram for com.UniPRT.Sdk.LabelMaker.Interface.IMaxicodeMsgStructured:
com.UniPRT.Sdk.LabelMaker.Interface.IMaxicodeData com.UniPRT.Sdk.LabelMaker.Abstract.AMaxicodeMsgStructured com.UniPRT.Sdk.LabelMaker.PGL.MaxicodeMsgStructured com.UniPRT.Sdk.LabelMaker.TSPL.MaxicodeMsgStructured

Public Member Functions

String GetPostalCode ()
 
void SetPostalCode (String postalCode)
 
String GetCountryCode ()
 
void SetCountryCode (String countryCode)
 
String GetServiceClass ()
 
void SetServiceClass (String serviceClass)
 
String GetRemainingMsg ()
 
void SetRemainingMsg (String remainingMsg)
 
- Public Member Functions inherited from com.UniPRT.Sdk.LabelMaker.Interface.IMaxicodeData
MaxicodeModeEnum GetMode ()
 The Mode used to state the format of the barcode data. See MaxicodeModeEnum for possible supported modes. More...
 
void SetMode (MaxicodeModeEnum mode)
 
String GetData ()
 The barcode data that includes the primary message + secondary messages to be encoded in the barcode. More...
 

Detailed Description

Maxicode barcode data. Maxicode Free Form carrier message. Only applies to Mode 2 and 3.

Modes 2, 3 "structured carrier message" requires fields for postal code, country code, and service class.

  • Message format typically encoded as follows:
    • <primaryMsg><secondaryMsg> = <postalCode>Gs<countryCode>Gs<serviceClass>Gs<secondaryMsg>EOT
  • Postal code (6-9 chars), country code (3 digits), service class (3 digits)
    • Mode 2 = US: up to 9 digit postal code (all numeric)
    • Mode 3 = Canada: 6 digit postal code (alphanumeric) Where:
  • Gs: Group Separator (0x1D)
  • EOT: End Of Transmit (0x04)

Member Function Documentation

◆ GetCountryCode()

String com.UniPRT.Sdk.LabelMaker.Interface.IMaxicodeMsgStructured.GetCountryCode ( )

◆ GetPostalCode()

String com.UniPRT.Sdk.LabelMaker.Interface.IMaxicodeMsgStructured.GetPostalCode ( )

◆ GetRemainingMsg()

String com.UniPRT.Sdk.LabelMaker.Interface.IMaxicodeMsgStructured.GetRemainingMsg ( )

◆ GetServiceClass()

String com.UniPRT.Sdk.LabelMaker.Interface.IMaxicodeMsgStructured.GetServiceClass ( )

◆ SetCountryCode()

void com.UniPRT.Sdk.LabelMaker.Interface.IMaxicodeMsgStructured.SetCountryCode ( String  countryCode)

◆ SetPostalCode()

void com.UniPRT.Sdk.LabelMaker.Interface.IMaxicodeMsgStructured.SetPostalCode ( String  postalCode)

◆ SetRemainingMsg()

void com.UniPRT.Sdk.LabelMaker.Interface.IMaxicodeMsgStructured.SetRemainingMsg ( String  remainingMsg)

◆ SetServiceClass()

void com.UniPRT.Sdk.LabelMaker.Interface.IMaxicodeMsgStructured.SetServiceClass ( String  serviceClass)

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