MIRA
ChannelHysteresis.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 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 
47 #ifndef _MIRA_CHANNELHYSTERESIS_H_
48 #define _MIRA_CHANNELHYSTERESIS_H_
49 
51 #include <fw/Framework.h>
52 
53 namespace mira {
54 
56 
82 template <typename T>
84 {
85 public:
86  ChannelHysteresis(const T& lower, const T& upper) :
87  mHysteresis(lower, upper)
88  {}
89 
98  const std::string& channelID,
99  boost::function<void (typename SchmittTriggerHysteresis<T>::State,
100  ChannelRead<T>)> fn)
101  {
102  mFunction = fn;
103  return authority.subscribe<T>(channelID, &ChannelHysteresis<T>::callback, this);
104  }
105 
109  template<typename Class>
111  const std::string& channelID,
113  Class* obj)
114  {
115  return subscribe(authority, channelID, boost::bind(f, obj, _1, _2));
116  }
117 
120  {
121  if (mHysteresis.update(value->value()))
122  mFunction(mHysteresis.getState(), value);
123  }
124 
125 private:
127  SchmittTriggerHysteresis<T> mHysteresis;
128 };
129 
131 
132 }
133 
134 #endif
Channel< T > subscribe(Authority &authority, const std::string &channelID, void(Class::*f)(typename SchmittTriggerHysteresis< T >::State, ChannelRead< T >), Class *obj)
Same as above but with a function and object pointer.
Definition: ChannelHysteresis.h:110
void callback(ChannelRead< T > value)
Called when channel has new data.
Definition: ChannelHysteresis.h:119
Class realizing a Schmitt trigger.
Definition: SchmittTriggerHysteresis.h:65
An exception that occurs whenever a channel has no data.
Definition: Channel.h:88
specialize cv::DataType for our ImgPixel and inherit from cv::DataType<Vec>
Definition: IOService.h:67
Class object which supports some kind of class reflection.
Definition: Class.h:97
An object that allows read access to data of a channel.
Definition: ChannelReadWrite.h:494
Authorities act as a facade to the framework.
Definition: Authority.h:94
Channel< T > subscribe(Authority &authority, const std::string &channelID, boost::function< void(typename SchmittTriggerHysteresis< T >::State, ChannelRead< T >)> fn)
Call this instead of Authority::subscribe()
Definition: ChannelHysteresis.h:97
ChannelHysteresis(const T &lower, const T &upper)
Definition: ChannelHysteresis.h:86
Class that can be registered as a filter when subscribing to channels to only get a callback when the...
Definition: ChannelHysteresis.h:83
typename Reflector::ReflectState State
Definition: ReflectorMacros.h:59
The framework that holds all manager classes and provides startup and shutdown of all framework relat...
Channel< T > subscribe(const std::string &channelID, const Duration &storageDuration=Duration::seconds(0))
Subscribes authority to a given channel.
State
State of the trigger.
Definition: SchmittTriggerHysteresis.h:71
Dual threshold hysteresis trigger class.