// Created with MonoDevelop
//
//    QuickStep: Acquire, view and identify spectra 
//    Copyright (C) 2020 Hiperscan GmbH Dresden, Germany
//
//    This program is free software: you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation, either version 3 of the License, or
//    (at your option) any later version.
//
//    This program is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with this program.  If not, see <http://www.gnu.org/licenses/>.

using System;


namespace Hiperscan.Extensions.ApoIdentCommon.Scanner
{
    public interface IScanner
    {
        // version number of the Scanner Software module
        Version Version { get; }

        // type (designation) of the Scanner device, null if not available
        string ScannerType { get; }

        // initialize Scanner Software module (executed if module is available while Apo-Ident Init())
        int Init(byte[] pzn_data);

        // deinit Scanner Software module (executed if module is available while Apo-Ident Quit())
        int Exit();

        // read Scanner information from Software module, return information aqcuired while last scan or null if no data is available
        // if an information has been returned, next call must result in null
        ScannerInfo GetScannerInfo();

        //For scanner in keyboard mode
        void EmitScan(string raw_data, bool capslock_active);

        bool HasPpnData { get; }
    }
}