flexiport.h

Go to the documentation of this file.

/* Flexiport
 *
 * Header file for the factory functions.
 *
 * Copyright 2008-2011 Geoffrey Biggs geoffrey.biggs@aist.go.jp
 *     RT-Synthesis Research Group
 *     Intelligent Systems Research Institute,
 *     National Institute of Advanced Industrial Science and Technology (AIST),
 *     Japan
 *     All rights reserved.
 *
 * 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 2.1 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