clock.h

Go to the documentation of this file.

//    sampalib.org ESL library and tools
//    Copyright (C) 2007  Thierry Grellier
//
//    This program is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License version 2 as
//    published by the Free Software Foundation.
//
//    This program is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License along
//    with this program; if not, write to the Free Software Foundation, Inc.,
//    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
//    contact: www.sampalib.org

#ifndef SAMPA_CLOCK_H
#define SAMPA_CLOCK_H

#include "sampa/core/module.h"
#include "sampa/core/event.h"
#include "sampa/core/time.h"

namespace Sampa {

  class Clock : public ContainerObject {
    SAMPA_PERSISTENT(Clock);
  public:
    enum Mode { RISE_ONLY, FALL_ONLY, RISE_AND_FALL };
    Clock(const Name& name);
    EventListener& get_rising_event()           { return e_rising_edge; }
    EventListener& get_falling_event()          { return e_falling_edge; }
    const Time& get_period() const              { return m_period; }
    unsigned long long get_rising_count() const;
  protected:
    Clock(const Name& name, ActualClock* rising_edge, ActualClock* falling_edge); 
    friend class ClockedEvent;
    friend class ClockedEventSingle;
    friend class Divider;
    static void start_at(ActualClock*, const Time&);
    ActualEvent* wait_n_rising(int n);    
    ActualEvent* wait_n_falling(int n);    
    TimeParameter      m_period;
    ActualClock*       m_rising_clock;
    ActualClock*       m_falling_clock;
    EventListener      e_rising_edge; // feed with actualclock
    EventListener      e_falling_edge; // feed with actualclock
  };

  class Divider : public Clock {
    SAMPA_PERSISTENT(Divider);
  public:
    Divider(const Name& name);
    void bind_clock(Clock*);
  };

}

#endif

---