ostc_companion: Serial.h annotate

annotate Serial.h @ 4:e30f00f760d3 default tip

Cleanup OSTC label and removed url The computer type will now show OSTC 4/5 instead of only 4. The url has been removed because it is no longer maintained. The ui header have been deleted because they are generated files shich should not be under version controll. Delete locally if you want to force an update of the dialog layout.

author	Ideenmodellierer
date	Sun, 30 Nov 2025 18:37:32 +0100
parents	0b3630a29ad8
children

rev	line source
1 0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	1 //////////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	2 /// \file Serial.h
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	3 /// \brief RS232 serial i/o.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	4 /// \author JD Gascuel.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	5 ///
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	6 /// \copyright (c) 2011-2016 JD Gascuel. All rights reserved.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	7 /// $Id$
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	8 //////////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	9 //
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	10 // BSD 2-Clause License:
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	11 //
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	12 // Redistribution and use in source and binary forms, with or without
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	13 // modification, are permitted provided that the following conditions
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	14 // are met:
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	15 //
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	16 // 1. Redistributions of source code must retain the above copyright notice,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	17 // this list of conditions and the following disclaimer.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	18 //
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	19 // 2. Redistributions in binary form must reproduce the above copyright notice,
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	20 // this list of conditions and the following disclaimer in the documentation
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	21 // and/or other materials provided with the distribution.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	22 //
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	23 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	24 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	25 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	26 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	27 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	28 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	29 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	30 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	31 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	32 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	33 // THE POSSIBILITY OF SUCH DAMAGE.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	34 //
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	35 //////////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	36 // HISTORY
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	37 // 2012-09-22 : [jDG] Split from Frog.cpp to OSTC_Planner.cpp
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	38 // 2013-03-17 : [jDG] Adapted from OSTC Planner to OSTC Companion.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	39 // 2014-07-07 : [jDG] Cleanups for Subsurface google-summer-of-code.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	40 // 2014-07-25 : [jDG] BSD 2-clause license.
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	41
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	42 #ifndef SERIAL_H
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	43 #define SERIAL_H
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	44
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	45 class QString;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	46
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	47 #include <QtGlobal> // Q_OS_WIN
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	48
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	49 #ifdef Q_OS_WIN
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	50 #ifndef NOMINMAX
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	51 # define NOMINMAX
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	52 #endif
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	53 //# define NOMINMAX
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	54 # include <windows.h>
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	55 # define S_HANDLE HANDLE
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	56 # undef NOMINMAX
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	57 #else
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	58 # define S_HANDLE int
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	59 #endif
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	60
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	61 //////////////////////////////////////////////////////////////////////////////
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	62 // \brief RS232 serial i/o
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	63 class Serial
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	64 {
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	65 S_HANDLE _hSerial;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	66 bool _isOpen;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	67
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	68 public:
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	69 inline Serial()
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	70 : _hSerial(0),
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	71 _isOpen(false)
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	72 {}
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	73
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	74 virtual ~Serial();
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	75
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	76 virtual void open(const QString &port, const QString& type);
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	77 virtual void close();
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	78
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	79 virtual void writeByte(unsigned char byte) const;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	80 virtual unsigned char readByte() const;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	81
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	82 virtual void writeBlock(const unsigned char* ptr, unsigned int size) const;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	83 virtual unsigned int readBlock(unsigned char* ptr, unsigned int size) const;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	84
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	85 virtual void purge();
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	86 virtual void flush() const;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	87
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	88 void writeShort(unsigned short word) const;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	89 unsigned short readShort() const;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	90
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	91 void writeInt24(unsigned int int24) const;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	92 unsigned int readInt24() const;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	93
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	94 void sleep(int msec) const;
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	95
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	96 inline bool isOpen() const { return _isOpen; }
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	97 };
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	98
0b3630a29ad8 Initial version based on previous repository. Ideenmodellierer <tiefenrauscher@web.de> parents: diff changeset	99 #endif // SERIAL_H

Mercurial > public > ostc_companion

annotate Serial.h @ 4:e30f00f760d3 default tip