flexiport.h

/*
 * GearBox Project: Peer-Reviewed Open-Source Libraries for Robotics
 *               http://gearbox.sf.net/
 * Copyright (c) 2008 Geoffrey Biggs
 *
 * flexiport flexible hardware data communications library.
 *
 * This distribution is licensed to you under the terms described in the LICENSE file included in
 * this distribution.
 *
 * This work is a product of the National Institute of Advanced Industrial Science and Technology,
 * Japan. Registration number: H20PRO-881
 *
 * This file is part of flexiport.
 *
 * flexiport is free software: you can redistribute it and/or modify it under the terms of the GNU
 * Lesser General Public License as published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version.
 *
 * flexiport 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with flexiport.
 * If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __FLEXIPORT_H
#define __FLEXIPORT_H

#include <map>
#include <string>

#if defined (WIN32)
        #if defined (FLEXIPORT_STATIC)
                #define FLEXIPORT_EXPORT
        #elif defined (FLEXIPORT_EXPORTS)
                #define FLEXIPORT_EXPORT    __declspec (dllexport)
        #else
                #define FLEXIPORT_EXPORT    __declspec (dllimport)
        #endif
#else
        #define FLEXIPORT_EXPORT
#endif

namespace flexiport
{

class FLEXIPORT_EXPORT PortException : public std::exception
{
        public:
                PortException (const char *errorStr)
                        : _errorStr (errorStr)  {};
                PortException (const std::string &errorStr)
                        : _errorStr (errorStr)  {};
                ~PortException () throw () {};

                virtual const char* what () const throw ()
                {
                        return _errorStr.c_str ();
                }

        private:
                std::string _errorStr;
};

// Forward declaration of the Port class
class Port;

FLEXIPORT_EXPORT Port* CreatePort (std::map<std::string, std::string> options);

FLEXIPORT_EXPORT Port* CreatePort (std::string options);

} // namespace flexiport

#endif // __FLEXIPORT_H