#
# Copyright 2005,2006,2009,2014 Free Software Foundation, Inc.
# 
# This file is part of GNU Radio
# 
# GNU Radio is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
# 
# GNU Radio 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 GNU Radio; see the file COPYING.  If not, write to
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
# 

This directory contains the GNU Radio eventstream scheduler 

These blocks are intended to help improve the translation of 
streams of data items into scheduled-finite length events 
occurring in the data streams in both directions.

* es.sink provides the translation from stream to events
* es.source provides the translation from events to streams

* triggers cause events to be scheduled in es.source 
 and es.sink block event queues.

Some examples of specific triggers included are,
    - es_trigger_edge_f: cause an event when float stream rises
                         above a fixed threshold value
    - es_trigger_sample_timer: cause an event to occur on 
                    a periodic sample increment in the stream

* handlers consume events and do some ammount of signal
  processing on them

Some example of specific handlers included are,
    - es_handler_print: print the event to STDOUT
    - es_handler_pdu: convert the event to a PDU and send
                        it out a message port
    - es_handler_insert_vector: a source handler which
                populates an event window from a PMT vector
    - es_handler_file: a sink handler which writes event
                contents out to a file