summaryrefslogtreecommitdiff
path: root/2005/i/robert/src/serial/serial_base.hh
blob: 9caf27db9e948f4a7e602b7f6ef7a6abae0b983a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
#ifndef serial_base_hh
#define serial_base_hh
// serial_base.hh
// robert - programme du robot 2005. {{{
//
// Copyright (C) 2005 Nicolas Schodet
//
// Robot APB Team/Efrei 2005.
//        Web: http://assos.efrei.fr/robot/
//      Email: robot AT efrei DOT fr
//
// 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 2 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, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// }}}

#include <unistd.h>
#include <string>

/// Classe de base pour un port s�rie.
class SerialBase
{
  protected:
    /// Descripteur de fichier utilis� par les fonctions de lecture.
    int fdIn_;
    /// Descripteur de fichier utilis� par les fonctions d'�criture.
    int fdOut_;
  public:
    /// Constructeur.
    SerialBase (void);
    /// Destructeur.
    virtual ~SerialBase (void);
    /// Ouvre et param�tre le port s�rie. \a ttyname peut �tre un device
    /// ("/dev/tty00,115200", voir SerialDev), un programme pr�c�d� d'un tube
    /// ("|simul_asserv", voir SerialPipe) ou l'entr�e/sortie standard ("-").
    virtual void open (const std::string &ttyname) = 0;
    /// Ferme le port s�rie, appell� automatiquement dans le destructeur.
    virtual void close (void) = 0;
    /// Lit un bloc, retourne le nombre d'octets lus ou <= 0 en cas d'erreur
    /// ou si aucun caract�re n'est disponible. Pour le robot, pr�ferer en
    /// g�n�ral getchar() pour du non-bloquant.
    ssize_t read (void *buf, size_t size);
    /// Lit un caract�re, ou -1 en cas d'erreur ou si aucun caract�re n'est
    /// disponible.
    int getchar (void);
    /// Ecrit un bloc.
    void write (const void *buf, size_t size);
    /// Ecrit un caract�re.
    void putchar (int c);
    /// Attend que des caract�res soient disponibles pendant un delay en
    /// millisecondes.
    bool wait (int timeout = -1);
    /// R�cup�re le descripteur.
    int getFd (void) { return fdIn_; }
};

#endif // serial_base_hh