Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

GrSink.h

Go to the documentation of this file.
00001 /* -*- Mode: c++ -*- */
00002 /*
00003  * Copyright 2001,2003 Free Software Foundation, Inc.
00004  * 
00005  * This file is part of GNU Radio
00006  * 
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 2, or (at your option)
00010  * any later version.
00011  * 
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  * 
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00020  * Boston, MA 02111-1307, USA.
00021  */
00022 /*
00023  *  Copyright 1997 Massachusetts Institute of Technology
00024  * 
00025  *  Permission to use, copy, modify, distribute, and sell this software and its
00026  *  documentation for any purpose is hereby granted without fee, provided that
00027  *  the above copyright notice appear in all copies and that both that
00028  *  copyright notice and this permission notice appear in supporting
00029  *  documentation, and that the name of M.I.T. not be used in advertising or
00030  *  publicity pertaining to distribution of the software without specific,
00031  *  written prior permission.  M.I.T. makes no representations about the
00032  *  suitability of this software for any purpose.  It is provided "as is"
00033  *  without express or implied warranty.
00034  * 
00035  */
00036 
00037 /*
00038  * Look Ma! No templates!
00039  */
00040 
00041 #ifndef _GRSINK_H_
00042 #define _GRSINK_H_
00043 
00044 #include <VrSigProc.h>
00045 #include <stddef.h>             // size_t
00046 
00047 class GrSink : public VrSigProc {
00048 private:
00049   unsigned int d_optimalSize;
00050 
00051 public: 
00052   GrSink (size_t sizeof_iType);
00053 
00054   virtual const char *name() { return "GrSink"; }
00055 
00056   // standard "work" routine.  We have it call work3, which
00057   // doesn't pass unnecessary output pointers.
00058   
00059   virtual int work(VrSampleRange output, void *o[],
00060                    VrSampleRange inputs[], void *i[]) {
00061     return work3 (output, inputs, i);
00062   };
00063 
00064   virtual int work3(VrSampleRange output, 
00065                     VrSampleRange inputs[], void *i[]) = 0; 
00066 
00067 
00068   // FIXME does anyone actually use this?
00069   //  set this if you want the sink to use smaller chunks
00070   //  than the maxLatency would dictate
00071   void setOptimalSize (unsigned int s);
00072 
00073   // internal routines
00074   virtual void setup();
00075   void setup_upstream(); 
00076 };
00077 
00078 #endif // _GRSINK_H_
00079 

Generated on Tue Mar 15 23:48:04 2005 for GNU Radio by  doxygen 1.4.0