recognition/qr-extended-parameters.js

const _MwWrapper = require("../_mwbridge/_mw-wrapper.js");

/**
 * Stores a QR Structured Append information of recognized barcode
 * @example
 * //This sample shows how to get QR Structured Append data
 *
 * let reader = new BarCodeReader("test.png", null,  DecodeType.QR);
 * let results = reader.readBarCodes();
 * for(let i = 0; i < results.length; i++)
 * {
 *    let result = results[i];
 *    console.log("BarCode Type: " + result.getCodeTypeName());
 *    console.log("BarCode CodeText: " + result.getCodeText());
 *    console.log("QR Structured Append Quantity: " + result.getExtended().getQR().getQRStructuredAppendModeBarCodesQuantity());
 *    console.log("QR Structured Append Index: " + result.getExtended().getQR().getQRStructuredAppendModeBarCodeIndex());
 *    console.log("QR Structured Append ParityData: " + result.getExtended().getQR().getQRStructuredAppendModeParityData());
 * }
 */
class QRExtendedParameters extends _MwWrapper
{
    constructor(javaclass)
    {
        super(javaclass);
        this._initializeWrapperMembers()
    }

    _initializeWrapperMembers()
    {
    }

    /**
     * <p>Gets the QR structured append mode barcodes quantity. Default value is -1.</p>
     * Value: The quantity of the QR structured append mode barcode.
     * @return the QR structured append mode barcodes quantity.
     */
    getStructuredAppendModeBarCodesQuantity()
    {
        return this.getJavaClass().getStructuredAppendModeBarCodesQuantitySync();
    }

    /**
     * Gets the QR structured append mode barcodes quantity. Default value is -1.Value: The quantity of the QR structured append mode barcode.
     * @deprecated This property is obsolete and will be removed in future releases. Instead, use the getStructuredAppendModeBarCodesQuantity().
     */
    getQRStructuredAppendModeBarCodesQuantity()
    {
        return this.getJavaClass().getQRStructuredAppendModeBarCodesQuantitySync();
    }

    /**
     * <p>Gets the index of the QR structured append mode barcode. Index starts from 0. Default value is -1.</p>
     * Value: The quantity of the QR structured append mode barcode.
     * @return the index of the QR structured append mode barcode.
     */
    getStructuredAppendModeBarCodeIndex()
    {
        return this.getJavaClass().getStructuredAppendModeBarCodeIndexSync();
    }

    /**
     * Gets the index of the QR structured append mode barcode. Index starts from 0. Default value is -1.Value: The quantity of the QR structured append mode barcode.
     * @deprecated This property is obsolete and will be removed in future releases. Instead, use the getStructuredAppendModeBarCodeIndex().
     */
    getQRStructuredAppendModeBarCodeIndex()
    {
        return this.getJavaClass().getQRStructuredAppendModeBarCodeIndexSync();
    }

    /**
     * <p>Gets the QR structured append mode parity data. Default value is -1.</p>
     * Value: The index of the QR structured append mode barcode.
     * @return the QR structured append mode parity data.
     */
    getStructuredAppendModeParityData()
    {
        return this.getJavaClass().getStructuredAppendModeParityDataSync();
    }

    /**
     * Gets the QR structured append mode parity data. Default value is -1.Value: The index of the QR structured append mode barcode.
     * @deprecated This property is obsolete and will be removed in future releases. Instead, use the getStructuredAppendModeParityData().
     */
    getQRStructuredAppendModeParityData()
    {
        return this.getJavaClass().getQRStructuredAppendModeParityDataSync();
    }

    /**
     * <p>
     * Version of recognized QR Code. From Version1 to Version40.
     * </p>
     */
    getVersion()
    {
        return this.getJavaClass().getVersionSync();
    }

    /**
     * Version of recognized QR Code. From Version1 to Version40.
     * @return Version of recognized QR Code
     * @deprecated This property is obsolete and will be removed in future releases. Instead, use the getVersion().
     */
    getQRVersion()
    { return this.getJavaClass().getQRVersionSync(); }

    /**
     * Version of recognized MicroQR Code. From M1 to M4.
     * @return Version of recognized MicroQR Code. From M1 to M4.
     */
    getMicroQRVersion()
    { return this.getJavaClass().getMicroQRVersionSync(); }

    /**
     * Version of recognized RectMicroQR Code. From R7x43 to R17x139.
     * @return Version of recognized RectMicroQR Code
     */
    getRectMicroQRVersion()
    {
        return this.getJavaClass().getRectMicroQRVersionSync();
    }

    /**
     * <p>
     * Reed-Solomon error correction level of recognized barcode. From low to high: LevelL, LevelM, LevelQ, LevelH.
     * </p>
     */
    getErrorLevel()
    {
        return this.getJavaClass().getErrorLevelSync();
    }

    /**
     * Reed-Solomon error correction level of recognized barcode. From low to high: LevelL, LevelM, LevelQ, LevelH.
     * @return Reed-Solomon error correction level of recognized barcode.
     * @deprecated This property is obsolete and will be removed in future releases. Instead, use the getErrorLevel().
     */
    getQRErrorLevel()
    {return this.getJavaClass().getQRErrorLevelSync(); }

    /**
     * <p>Tests whether all parameters has only default values</p>Value
     * @returns <b>true</b> if all parameters has only default values; otherwise, {@code <b>false</b>}.
     */
    isEmpty()
    {
        return this.getJavaClass().isEmptySync();
    }

    /**
     * Returns a value indicating whether this instance is equal to a specified QRExtendedParameters value.
     *
     * @param obj An object value to compare to this instance.
     * @return true if obj has the same value as this instance; otherwise, false.
     */
    equals(obj)
    {
        return this.getJavaClass().equalsSync(obj.getJavaClass());
    }

    /**
     * Returns the hash code for this instance.
     *
     * @return A 32-bit signed integer hash code.
     */
    hashCode()
    {
        return this.getJavaClass().hashCodeSync();
    }

    /**
     * Returns a human-readable string representation of this QRExtendedParameters.
     *
     * @return A string that represents this QRExtendedParameters.
     */
    toString()
    {
        return this.getJavaClass().toStringSync();
    }
}

module.exports = QRExtendedParameters;