ParticipantConfig.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of the RSB project.
 *
 * Copyright (C) 2011 by Johannes Wienke <jwienke at techfak 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 <set>
#include <string>
#include <ostream>

#include <boost/operators.hpp>
#include <boost/filesystem/path.hpp>

#include <rsc/logging/Logger.h>
#include <rsc/config/OptionHandler.h>
#include <rsc/runtime/Properties.h>
#include <rsc/runtime/Printable.h>

#include "QualityOfServiceSpec.h"
#include "rsb/rsbexports.h"

namespace rsb {

class RSB_EXPORT ParticipantConfig: public rsc::config::OptionHandler,
                                    public rsc::runtime::Printable {
public:

    class RSB_EXPORT Transport: boost::totally_ordered<Transport>,
            public rsc::config::OptionHandler,
            public rsc::runtime::Printable {
    public:
        typedef std::set<std::pair<std::string, std::string> > ConverterNames;

        explicit Transport(const std::string& name,
                           bool enabled = true);
        virtual ~Transport();

        std::string getName() const;

        ConverterNames getConverters() const;

        rsc::runtime::Properties getOptions() const;

        rsc::runtime::Properties& mutableOptions();

        void setOptions(const rsc::runtime::Properties& options);

        bool isEnabled() const;

        void setEnabled(bool value);

        bool operator==(const Transport& other) const;
        bool operator<(const Transport& other) const;

        std::string getClassName() const;
        void printContents(std::ostream& stream) const;

        void handleOption(const std::vector<std::string>& key,
                const std::string& value);
    private:
        std::string name;
        ConverterNames converters;
        rsc::runtime::Properties options;
    };

    class RSB_EXPORT EventProcessingStrategy : public rsc::config::OptionHandler,
                                    public rsc::runtime::Printable {
    public:
        EventProcessingStrategy(const std::string& name);

        std::string getName() const;

        void setName(const std::string& name);

        rsc::runtime::Properties getOptions() const;

        rsc::runtime::Properties& mutableOptions();

        void setOptions(const rsc::runtime::Properties& options);

        void handleOption(const std::vector<std::string>& key,
                          const std::string& value);

        void printContents(std::ostream& stream) const;
    private:
        std::string name;
        rsc::runtime::Properties options;
    };

    enum ErrorStrategy {
        LOG,
        PRINT,
        EXIT
    };

    ParticipantConfig();
    virtual ~ParticipantConfig();

    QualityOfServiceSpec getQualityOfServiceSpec() const;

    QualityOfServiceSpec& mutableQualityOfServiceSpec();

    void setQualityOfServiceSpec(const QualityOfServiceSpec& spec);

    ErrorStrategy getErrorStrategy() const;

    void setErrorStrategy(const ErrorStrategy& strategy);

    std::set<Transport> getTransports(bool includeDisabled = false) const;

    Transport getTransport(const std::string& name) const;

    Transport& mutableTransport(const std::string& name);

    void addTransport(const Transport& transport);

    void removeTransport(const Transport& transport);

    void setTransports(const std::set<Transport>& transports);

    const EventProcessingStrategy& getEventReceivingStrategy() const;

    EventProcessingStrategy& mutableEventReceivingStrategy();


    const EventProcessingStrategy& getEventSendingStrategy() const;

    rsc::runtime::Properties getOptions() const;

    rsc::runtime::Properties& mutableOptions();

    void setOptions(const rsc::runtime::Properties& options);

    static ParticipantConfig fromFile(const boost::filesystem::path& path,
            const ParticipantConfig& defaults = ParticipantConfig());

    static ParticipantConfig fromEnvironment(const ParticipantConfig& defaults =
            ParticipantConfig());

    static ParticipantConfig fromConfiguration(
            const ParticipantConfig& defaults = ParticipantConfig());
private:
    rsc::logging::LoggerPtr logger;

    QualityOfServiceSpec             qosSpec;
    ErrorStrategy                    errorStrategy;
    std::map<std::string, Transport> transports;
    EventProcessingStrategy          eventReceivingStrategy;
    EventProcessingStrategy          eventSendingStrategy;
    rsc::runtime::Properties         options;

    void handleOption(const std::vector<std::string>& key,
            const std::string& value);

    void printContents(std::ostream& stream) const;
};

}