---

/root/src/subsynth/syn/Core/Terminal.h

Go to the documentation of this file.

/****************** <SYN heading BEGIN do not edit this line> *****************
 *
 * subsynth - modular audio synthesizer
 * subsynth is (C) Copyright 2001-2002 by Kevin Meinert
 *
 * Original Author: Kevin Meinert
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile: Terminal.h,v $
 * Date modified: $Date: 2002/04/15 01:55:54 $
 * Version:       $Revision: 1.13 $
 * -----------------------------------------------------------------
 *
 ****************** <SYN heading END do not edit this line> ******************/

#ifndef SUBSYNTH_TERMINAL
#define SUBSYNTH_TERMINAL

#include <string>
//#include <syn/ConnectionPtr.h>
#include <syn/Core/Connection.h>
#include <syn/Core/SampleBufferQueue.h>
#include <syn/Core/TerminalPtr.h>

namespace syn
{
   class Module;
   
   class Terminal
   {
   public:
      Terminal( Module& module, const std::string& name = "unnamed" );
      virtual ~Terminal();

      /* the name of this instance of terminal */
      const std::string& name() const;
      void setName( const std::string& name );

      virtual void disconnect();

      virtual bool isConnected() const;
         
      static void connect( TerminalPtr inptr, TerminalPtr outptr  );

      Connection& connection();
      
      const Module& module() const { return mModule; }
      
      Module& module() { return mModule; }

      void push( SampleBuffer1f* buf ) { queue().push( buf ); }
      
      void pop() { queue().pop(); }
      
      SampleBuffer1f* front() { return queue().front(); }
      
      bool high() const { return queue().high(); }

      bool low() const { return queue().low(); }
      
      bool empty() const { return queue().empty(); }
      
      unsigned int size() const { return queue().size(); }
      
      bool done();

      void setDone( bool d );
      
      void setHighMark( unsigned int h ) { queue().setHighMark( h ); }
      
      void setLowMark( unsigned int l ) { queue().setLowMark( l ); }
      
      inline unsigned int highMark() const { return queue().highMark(); }
      
      inline unsigned int lowMark() const { return queue().lowMark(); }
   
   private:
      void setConnection( ConnectionPtr conn );
   
      SampleBufferQueue& queue()
      { 
         assert( mConnection.get() != NULL ); 
         return mConnection->queue(); 
      }
      const SampleBufferQueue& queue() const 
      { 
         assert( mConnection.get() != NULL ); 
         return mConnection->queue(); 
      }
         
      Module& mModule;
      std::string mName;
      ConnectionPtr mConnection;
      ConnectionPtr mDisconnect;
   };
   
}


#endif //TERMINAL

---