MIRA
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ChannelPromoteByTypename.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2018 by
3  * MetraLabs GmbH (MLAB), GERMANY
4  * and
5  * Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
6  * All rights reserved.
7  *
8  * Contact: info@mira-project.org
9  *
10  * Commercial Usage:
11  * Licensees holding valid commercial licenses may use this file in
12  * accordance with the commercial license agreement provided with the
13  * software or, alternatively, in accordance with the terms contained in
14  * a written agreement between you and MLAB or NICR.
15  *
16  * GNU General Public License Usage:
17  * Alternatively, this file may be used under the terms of the GNU
18  * General Public License version 3.0 as published by the Free Software
19  * Foundation and appearing in the file LICENSE.GPL3 included in the
20  * packaging of this file. Please review the following information to
21  * ensure the GNU General Public License version 3.0 requirements will be
22  * met: http://www.gnu.org/copyleft/gpl.html.
23  * Alternatively you may (at your option) use any later version of the GNU
24  * General Public License if such license has been publicly approved by
25  * MLAB and NICR (or its successors, if any).
26  *
27  * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
28  * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
29  * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
30  * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
33  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
34  * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
35  * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
36  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
37  */
38 
48 #ifndef _MIRA_CHANNEL_PROMOTE_BY_TYPENAME_H_
49 #define _MIRA_CHANNEL_PROMOTE_BY_TYPENAME_H_
50 
51 #include <fw/Channel.h>
52 
53 namespace mira {
54 
56 
58 
63 class TypedChannelPromoterBase : public Object
64 {
65  MIRA_ABSTRACT_OBJECT(TypedChannelPromoterBase)
66 
67 public:
69  virtual void promote(ConcreteChannel<void>* channel) const = 0;
70 };
71 
72 typedef boost::shared_ptr<TypedChannelPromoterBase> TypedChannelPromoterBasePtr;
73 
75 
76 class ChannelPromoteByTypename : public LazySingleton<ChannelPromoteByTypename>
77 {
78 
79 public:
80 
85  bool promoteChannel(ConcreteChannel<void>* channel, const Typename& channelType);
86 
90  template <typename PromoteFrom>
91  bool promoteChannel(ConcreteChannel<PromoteFrom>* channel,
92  const Typename& channelType)
93  {
94  return false;
95  }
96 
101  template <typename PromoteTo>
102  bool checkForPromoter(ConcreteChannel<PromoteTo>* channel)
103  {
104  return checkForPromoter(typeName<PromoteTo>(), channel->getID());
105  }
106 
111  bool checkForPromoter(ConcreteChannel<void>* channel)
112  {
113  return false;
114  }
115 
116 private:
117 
118  bool checkForPromoter(const Typename& channelType, const std::string& channelID);
119  void lookForNewPromoters();
120  std::string getSourceHint();
121 
122 private:
123 
125  std::set<ClassProxy> mKnownPromoterClasses;
126 
128  std::multimap<Typename, ClassProxy> mKnownPromoters;
129 
131  std::map<Typename, TypedChannelPromoterBasePtr> mInstantiatedPromoters;
132 
134  boost::mutex mMutex;
135 };
136 
138 
140 
141 } // namespace
142 
143 #endif
std::string Typename
Definition: Typename.h:59
#define MIRA_ABSTRACT_OBJECT(classIdentifier)
Use this MACRO instead of MIRA_OBJECT to declare the class as abstract.
Definition: FactoryMacros.h:239
json_spirit::mObject Object
A representation of an object (class, struct) in JSON.
Definition: JSON.h:183
Framework channel classes.