Port.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of CCA project
 *
 * Copyright (C) 2011 by Arne Nordmann <anordman at cor-lab dot uni-bielefeld dot de>
 *
 * This file may be licensed under the terms of the
 * GNU Lesser General Public License Version 3 (the ``LGPL''),
 * or (at your option) any later version.
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the LGPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the LGPL along with this
 * program. If not, go to http://www.gnu.org/licenses/lgpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The development of this software was supported by:
 *   CoR-Lab, Research Institute for Cognition and Robotics
 *     Bielefeld University
 *
 * ============================================================ */

#pragma once

#include <boost/shared_ptr.hpp>

#include <rsb/Scope.h>

#include "port/PortConfiguration.h"

namespace cca {

class Port;
typedef ::boost::shared_ptr<Port> PortPtr;

class Port {

public:

    static const bool MANDATORY = false;
    static const bool OPTIONAL = true;

    virtual bool isReady() const;

    virtual void makeOptional(bool optional);

    virtual bool isOptional() const;

    void configure(const std::string &scope);

    void configure(PortConfigurationPtr config);

    virtual void configureSpecifics() = 0;

    virtual PortConfigurationPtr getConfig() const;

    virtual ::rsb::ScopePtr getScopePtr() const;

    virtual bool isLocalPort();

    virtual bool isRemotePort();

    virtual ~Port();

    virtual std::string print() const = 0;

protected:
    Port(bool optional = false);

    PortConfigurationPtr config;

    bool configured, optional;

};

}