xid_con_t.h

Go to the documentation of this file.

/* Copyright (c) 2010, Cedrus Corporation
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.  
 *
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * Neither the name of Cedrus Corporation nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef XID_CON_T_H
#define XID_CON_T_H

#include "port_settings_t.h"
#include "constants.h"
#include <Windows.h>

namespace cedrus
{
    class xid_con_t
    {
    public:
        
        xid_con_t(
            const std::wstring &port_name,
            int port_speed = 115200,
            int delay_ms = 1,
            port_settings_t::bytesize byte_size = port_settings_t::BYTESIZE_8,
            port_settings_t::bitparity bit_parity = port_settings_t::BITPARITY_NONE,
            port_settings_t::stopbits stop_bits = port_settings_t::STOP_BIT_1
            );

        virtual ~xid_con_t();

        int close();

        int flush_input();

        int flush_output();

        int open();

        int read(
            unsigned char *in_buffer,
            int bytes_to_read,
            int &bytes_read);

        int write(
            unsigned char * const in_buffer,
            int bytes_to_write,
            int &bytes_written);

        key_state check_for_keypress();

        void remove_current_response();

        void get_current_response(
            int &port, int &key, bool &was_pressed, int &reaction_time);

        int get_number_of_keys_down();

        int send_xid_command(
            const char in_command[],
            int num_bytes,
            char out_response[],
            int max_out_response_size,
            int expected_bytes_rec,
            int timeout = 100,
            int command_delay = 0);

        void set_needs_interbyte_delay(bool need_delay = true);

        void set_digital_out_prefix(char prefix);

        void set_digital_output_lines(
            unsigned int lines,
            bool leave_remaining_lines = false);

        void clear_digital_output_lines(
            unsigned int lines,
            bool leave_remaining_lines = false);

    private:
        int setup_com_port();
        void setup_dcb(DCB &dcb) const;
        void setup_timeouts(COMMTIMEOUTS &ct) const;

        key_state xid_input_found();

        port_settings_t port_settings_;
        int in_buffer_size_;
        int out_buffer_size_;
        int model_id_;
        wchar_t port_name_[40];
        HANDLE device_id_;
        
        int delay_;

        enum {INPUT_BUFFER_SIZE = 1000};
        enum {XID_PACKET_SIZE = 6};
        enum {INVALID_PACKET_INDEX = -1};
        enum {KEY_RELEASE_BITMASK = 0x10};
        
        int bytes_in_buffer_;
        unsigned char input_buffer_[INPUT_BUFFER_SIZE];
        unsigned char invalid_port_bits_;

        const double timer_rate_;

        int first_valid_xid_packet_;
        int num_keys_down_;
        int last_resp_port_;
        int last_resp_key_;
        bool last_resp_pressed_;
        int last_resp_rt_;

        char lines_state_;
        char set_lines_cmd_[4];

        bool needs_interbyte_delay_;
    };
} // namespace cedrus

#endif // XID_CON_T_H