PortConfiguration.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 <rsb/Scope.h>
#include <rsb/ParticipantConfig.h>

namespace cca {

class PortConfiguration;
typedef boost::shared_ptr<PortConfiguration> PortConfigurationPtr;

class PortConfiguration {

public:

    typedef enum {
        CCALocal = 1, CCARemote = 2, CCALocalRemote = 3
    } Transport;

    virtual std::string print() const;

    static PortConfigurationPtr DEFAULT(const std::string &scope,
            unsigned int queuesize = 1, bool keeplatest = true);

    static PortConfigurationPtr LOCAL(const std::string &scope,
            unsigned int queuesize = 1, bool keeplatest = true);

    static PortConfigurationPtr REMOTE(const std::string &scope,
            unsigned int queuesize = 1, bool keeplatest = true);

    static PortConfigurationPtr LOCALREMOTE(const std::string &scope,
            unsigned int queuesize = 1, bool keeplatest = true);

    static PortConfigurationPtr PROFILE(const std::string &profile,
            const std::string &scope, unsigned int queuesize = 1,
            bool keeplatest = true);

    static PortConfigurationPtr create(Transport transport,
            const std::string &scope, unsigned int queuesize = 1,
            bool keeplatest = true);

    static PortConfigurationPtr create(const std::string &profile,
            const std::string &scope, unsigned int queuesize = 1,
            bool keeplatest = true);

    void setQueueSize(unsigned int queuesize = 1);

    unsigned int getQueueSize() const;

    void setKeepLatest(bool keeplatest = true);

    bool keepLatest();

    virtual rsb::ScopePtr getScopePtr() const;

    virtual rsb::ParticipantConfig rsbConfig() const;

    virtual rsb::ParticipantConfig& rsbConfigMutable();

    virtual bool isLocalPort() const;

    virtual bool isRemotePort() const;

    virtual ~PortConfiguration();

protected:
    PortConfiguration(const std::string &scope, unsigned int queuesize = 1,
            bool keeplatest = true);

    PortConfiguration(const std::string &scope, bool local, bool remote,
            unsigned int queuesize = 1, bool keeplatest = true);

    bool local;

    bool remote;

    bool keeplatest;

    rsb::ScopePtr scope;

    rsb::ParticipantConfig rsbconfig;

    unsigned int queuesize;

};

bool operator==(PortConfigurationPtr const a, PortConfigurationPtr const b);

}