recognition/dotcode-extended-parameters.js

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

/**
 * <p>
 * Stores special data of DotCode recognized barcode
 * </p>
 * This sample shows how to get DotCode raw values<br>
 *
 * @example
 * let generator = new BarcodeGenerator(EncodeTypes.DOT_CODE, "12345");
 * generator.save("test.png", BarCodeImageFormat.PNG);
 *
 * let reader = new BarCodeReader("test.png", null, DecodeType.DOT_CODE);
 * let results = reader.readBarCodes();
 * for(let i = 0; i < results.length; i++)
 * {
 *     let result = results[i];
 *     print("BarCode type: " + result.getCodeTypeName());
 *     print("BarCode codetext: " + result.getCodeText());
 *     print("DotCode barcode ID: " + result.getExtended().getDotCode().getDotCodeStructuredAppendModeBarcodeId());
 *     print("DotCode barcodes count: " + result.getExtended().getDotCode().getDotCodeStructuredAppendModeBarcodesCount());
 * }
 */
class DotCodeExtendedParameters extends _MwWrapper
{
    constructor(mwObject)
    {
        super(mwObject);
    }

    /**
     * <p>Gets the DotCode structured append mode barcodes count. Default value is -1. Count must be a value from 1 to 35.</p>
     * Value: The count of the DotCode structured append mode barcode.
     * @return the DotCode structured append mode barcodes count.
     */
    getStructuredAppendModeBarcodesCount()
    {
        return this.getJavaClass().getStructuredAppendModeBarcodesCountSync();
    }

    /**
     * <p>Gets the DotCode structured append mode barcodes count. Default value is -1. Count must be a value from 1 to 35.</p>Value: The count of the DotCode structured append mode barcode.
     * @deprecated This property is obsolete and will be removed in future releases. Instead, use the getStructuredAppendModeBarcodesCount().
     */
    getDotCodeStructuredAppendModeBarcodesCount()
    { return this.getJavaClass().getDotCodeStructuredAppendModeBarcodesCountSync(); }

    /**
     * <p>Gets the ID of the DotCode structured append mode barcode. ID starts from 1 and must be less or equal to barcodes count. Default value is -1.</p>
     * Value: The ID of the DotCode structured append mode barcode.
     * @return the ID of the DotCode structured append mode barcode.
     */
    getStructuredAppendModeBarcodeId()
    {
        return this.getJavaClass().getStructuredAppendModeBarcodeIdSync();
    }

    /**
     * <p>Gets the ID of the DotCode structured append mode barcode. ID starts from 1 and must be less or equal to barcodes count. Default value is -1.</p>Value: The ID of the DotCode structured append mode barcode.
     * @deprecated This property is obsolete and will be removed in future releases. Instead, use the getStructuredAppendModeBarcodeId().
     */
    getDotCodeStructuredAppendModeBarcodeId()
    { return this.getJavaClass().getDotCodeStructuredAppendModeBarcodeIdSync(); }

    /**
     * <p>
     * Indicates whether code is used for instruct reader to interpret the following data as instructions for initialization or reprogramming of the bar code reader.
     * Default value is false.
     * </p>
     */
    isReaderInitialization()
    {
        return this.getJavaClass().isReaderInitializationSync();
    }

    /**
     * <p>
     * Indicates whether code is used for instruct reader to interpret the following data as instructions for initialization or reprogramming of the bar code reader.
     * Default value is false.
     * </p>
     * @deprecated This property is obsolete and will be removed in future releases. Instead, use the isReaderInitialization().
     */
    getDotCodeIsReaderInitialization()
    {
        return this.getJavaClass().getDotCodeIsReaderInitializationSync();
    }

    /**
     * <p>
     * Returns a value indicating whether this instance is equal to a specified {@code DotCodeExtendedParameters} value.
     * </p>
     * @return {@code <b>true</b>} if obj has the same value as this instance; otherwise, {@code <b>false</b>}.
     * @param obj An System.Object value to compare to this instance.
     */
    equals(obj)
    {
        return this.getJavaClass().equalsSync(obj.getJavaClass());
    }

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

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

    _initializeWrapperMembers()
    {
    }
}

module.exports = DotCodeExtendedParameters;