Socket/Protocols/Raw: EUI64 documentation
[senf.git] / PPI / RateFilter.hh
index 19cb3dc..dca0fbd 100644 (file)
@@ -1,6 +1,8 @@
+// $Id$
+//
 // Copyright (C) 2007
-// Fraunhofer Institute for Open Communication Systems (FOKUS) 
-// Competence Center NETwork research (NET), St. Augustin, GERMANY 
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
 //     Stefan Bund <g0dil@berlios.de>
 //
 // This program is free software; you can redistribute it and/or modify
 // along with this program; if not, write to the
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-#ifndef RATEFILTER_HH_
-#define RATEFILTER_HH_
+
+/** \file
+    \brief RateFilter public header */
+
+#ifndef HH_SENF_PPI_RateFilter_
+#define HH_SENF_PPI_RateFilter_ 1
 
 // Custom includes
 #include "Connectors.hh"
 #include "Module.hh"
 #include "IntervalTimer.hh"
 
+//#include "RateFilter.mpp"
+///////////////////////////////hh.p////////////////////////////////////////
 
 namespace senf {
 namespace ppi {
@@ -34,19 +42,35 @@ class RateFilter
     : public Module
 {
     SENF_PPI_MODULE(RateFilter);
-public:
 
+public:
+    RateFilter(senf::ClockService::clock_type interval);
+    void interval(senf::ClockService::clock_type interval);
+    senf::ClockService::clock_type interval() const;
+    
     connector::ActiveInput<> input;
     connector::ActiveOutput<> output;
 
-    RateFilter(senf::ClockService::clock_type interval);
-//    void changeInterval(senf::ClockService::clock_type interval);   not yet implemented!
-
 private:
     void timeout();
-    ppi::IntervalTimer timer;
+    ppi::IntervalTimer timer_;
 };
 
 }}} //namespaces
 
-#endif /*RATEFILTER_HH_*/
+///////////////////////////////hh.e////////////////////////////////////////
+//#include "RateFilter.cci"
+//#include "RateFilter.ct"
+//#include "RateFilter.cti"
+#endif
+
+\f
+// Local Variables:
+// mode: c++
+// fill-column: 100
+// c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
+// compile-command: "scons -u test"
+// comment-column: 40
+// End: