Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

LOW_portSerialFactory.h

Go to the documentation of this file.
00001 /***************************************************************************
00002                           LOW_portSerialFactory.h  -  description
00003                              -------------------
00004     begin                : Tue Jul 30 2002
00005     copyright            : (C) 2002 by Harald Roelle, Helmut Reiser
00006     email                : roelle@informatik.uni-muenchen.de, reiser@informatik.uni-muenchen.de
00007  ***************************************************************************/
00008 
00009 /***************************************************************************
00010  *                                                                         *
00011  *   This program is free software; you can redistribute it and/or modify  *
00012  *   it under the terms of the GNU General Public License as published by  *
00013  *   the Free Software Foundation; either version 2 of the License, or     *
00014  *   (at your option) any later version.                                   *
00015  *                                                                         *
00016  ***************************************************************************/
00017 
00018 #ifndef LOW_PORTSERIALFACTORY_H
00019 #define LOW_PORTSERIALFACTORY_H
00020 
00021 
00022 #include <string>
00023 
00024 
00025 #include "LOW_portSerial.h"
00026 
00027 
00028 /** Factory class for platform specific objects of LOW_portSerial.
00029 
00030     This class also contains platform specific type definitions.
00031 
00032     @see LOW_portSerial
00033 
00034     @author Harald Roelle, Helmut Reiser
00035  */
00036 class LOW_portSerialFactory {
00037 
00038 //=======================================================================================
00039 public: 
00040 
00041   //=====================================================================================
00042   //
00043   // type definitions
00044   //
00045 
00046 #ifdef __linux__
00047   /** Linux specific type for serial port unique identifier. */
00048   typedef string   portSpecifier_t;
00049 #endif
00050   
00051   //=====================================================================================
00052   //
00053   // static factory
00054   //
00055   
00056   /** Platform aware replacement for creating dynamic instances of LOW_portSerial.
00057       @param inPortSpec  Unique identifier for new serial port instance.
00058       @return  Pointer to new instance of LOW_portSerial.
00059    */
00060   static LOW_portSerial* new_portSerial( const portSpecifier_t inPortSpec);
00061 };
00062 
00063 #endif

Generated on Sun Jan 12 21:07:43 2003 by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001