ChannelPromoteByTypename.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_CHANNEL_PROMOTE_BY_TYPENAME_H_
#define _MIRA_CHANNEL_PROMOTE_BY_TYPENAME_H_

#include <fw/Channel.h>

namespace mira {



class TypedChannelPromoterBase : public Object
{
    MIRA_ABSTRACT_OBJECT(TypedChannelPromoterBase)

public:
    virtual void promote(ConcreteChannel<void>* channel) const = 0;
};

typedef boost::shared_ptr<TypedChannelPromoterBase> TypedChannelPromoterBasePtr;


class ChannelPromoteByTypename : public LazySingleton<ChannelPromoteByTypename>
{

public:

    bool promoteChannel(ConcreteChannel<void>* channel, const Typename& channelType);

    template <typename PromoteFrom>
    bool promoteChannel(ConcreteChannel<PromoteFrom>* channel,
                        const Typename& channelType)
    {
        return false;
    }

    template <typename PromoteTo>
    bool checkForPromoter(ConcreteChannel<PromoteTo>* channel)
    {
        return checkForPromoter(typeName<PromoteTo>(), channel->getID());
    }

    bool checkForPromoter(ConcreteChannel<void>* channel)
    {
        return false;
    }

private:

    bool checkForPromoter(const Typename& channelType, const std::string& channelID);
    void lookForNewPromoters();
    std::string getSourceHint();

private:

    std::set<ClassProxy> mKnownPromoterClasses;

    std::multimap<Typename, ClassProxy> mKnownPromoters; 

    std::map<Typename, TypedChannelPromoterBasePtr> mInstantiatedPromoters;

    boost::mutex mMutex;
};



} // namespace

#endif