/* This file is part of Ingen.  Copyright (C) 2006 Dave Robillard.
 * 
 * Ingen 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 2 of the License, or (at your option) any later
 * version.
 * 
 * Ingen 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 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 St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef OUTPUTPORT_H
#define OUTPUTPORT_H

#include <string>
#include <cstdlib>
#include "TypedPort.h"
#include "types.h"

namespace Ingen {

template <typename T> class InputPort;


/** An output port.
 *
 * Output ports always have a locally allocated buffer, and buffer() will
 * always return that buffer.  (This is very different from InputPort)
 *
 * This class actually adds no functionality to Port whatsoever right now,
 * it will in the future when more advanced port types exist, and it makes
 * things clearer throughout the engine.
 *
 * \ingroup engine
 */
template <typename T>
class OutputPort : virtual public TypedPort<T>
{
public:
	OutputPort(Node* parent, const string& name,
	           size_t index, size_t poly,
	           DataType type, size_t buffer_size)
	: TypedPort<T>(parent, name, index, poly, type, buffer_size)
	{}

	virtual ~OutputPort() {}

	bool is_input()  const { return false; }
	bool is_output() const { return true; }

private:
	// Prevent copies (undefined)
	OutputPort(const OutputPort& copy);
	OutputPort<T>& operator=(const OutputPort<T>&);
};


template class OutputPort<Sample>;

} // namespace Ingen

#endif // OUTPUTPORT_H