---

syn::Terminal Class Reference

A Terminal. More...

#include <Terminal.h>

Collaboration diagram for syn::Terminal:

[legend]List of all members.

Public Methods
	Terminal (Module &module, const std::string &name="unnamed")
virtual	~Terminal ()
const std::string&	name () const
void	setName (const std::string &name)
virtual void	disconnect ()
	remove any connection. More...
virtual bool	isConnected () const
	is there a connection. More...
Connection&	connection ()
	access the terminal's connection. More...
const Module&	module () const
	access my module. More...
Module&	module ()
	access my module. More...
Data Transport
void	push (SampleBuffer1f *buf)
	push a buffer into the terminal. More...
void	pop ()
	push a buffer out of the terminal. More...
SampleBuffer1f*	front ()
	look at the current buffer in the terminal. More...
bool	high () const
	return true if queue is filled to above the high mark. More...
bool	low () const
	return false if queue is filled to below the low mark. More...
bool	empty () const
	return true if this queue is empty. More...
unsigned int	size () const
	how many elements in the queue. More...
bool	done ()
	query if the terminal is done "done" signals whether you need to wait for more data from this terminal, of if you can go on. More...
void	setDone (bool d)
	set the connection to a done state. More...
Watermark methods
void	setHighMark (unsigned int h)
	set the high mark. More...
void	setLowMark (unsigned int l)
	set the low mark. More...
unsigned int	highMark () const
	what is the high mark. More...
unsigned int	lowMark () const
	what is the low mark. More...
Static Public Methods
void	connect (TerminalPtr inptr, TerminalPtr outptr)
	create a connection autoconnect. More...

---

Detailed Description

A Terminal.

terminals connect modules Terminal is used exclusively by Module, you should not use it on it's own.

Definition at line 51 of file Terminal.h.

---

Constructor & Destructor Documentation

syn::Terminal::Terminal ( Module & module, const std::string & name = "unnamed" )

Definition at line 38 of file Terminal.cpp.

syn::Terminal::~Terminal ( ) [virtual]

Definition at line 47 of file Terminal.cpp.

---

Member Function Documentation

const std::string & syn::Terminal::name ( ) const

Definition at line 64 of file Terminal.cpp.

void syn::Terminal::setName ( const std::string & name )

Definition at line 69 of file Terminal.cpp.

void syn::Terminal::disconnect ( ) [virtual]

remove any connection. Definition at line 76 of file Terminal.cpp.

bool syn::Terminal::isConnected ( ) const [virtual]

is there a connection. Definition at line 79 of file Terminal.cpp. Referenced by setDone().

void syn::Terminal::connect ( TerminalPtr inptr, TerminalPtr outptr ) [static]

create a connection autoconnect. Definition at line 90 of file Terminal.cpp.

Connection & syn::Terminal::connection ( )

access the terminal's connection. Definition at line 99 of file Terminal.cpp.

const Module & syn::Terminal::module ( ) const [inline]

access my module. Definition at line 78 of file Terminal.h.

Module & syn::Terminal::module ( ) [inline]

access my module. Definition at line 81 of file Terminal.h.

void syn::Terminal::push ( SampleBuffer1f * buf ) [inline]

push a buffer into the terminal. Definition at line 86 of file Terminal.h.

void syn::Terminal::pop ( ) [inline]

push a buffer out of the terminal. Definition at line 89 of file Terminal.h.

SampleBuffer1f * syn::Terminal::front ( ) [inline]

look at the current buffer in the terminal. Definition at line 92 of file Terminal.h.

bool syn::Terminal::high ( ) const [inline]

return true if queue is filled to above the high mark. Definition at line 95 of file Terminal.h.

bool syn::Terminal::low ( ) const [inline]

return false if queue is filled to below the low mark. Definition at line 98 of file Terminal.h.

bool syn::Terminal::empty ( ) const [inline]

return true if this queue is empty. Definition at line 101 of file Terminal.h.

unsigned int syn::Terminal::size ( ) const [inline]

how many elements in the queue. Definition at line 104 of file Terminal.h.

bool syn::Terminal::done ( )

query if the terminal is done "done" signals whether you need to wait for more data from this terminal, of if you can go on. when the terminal is "done", then you can go on without recieving data from it. Definition at line 52 of file Terminal.cpp.

void syn::Terminal::setDone ( bool d )

set the connection to a done state. this affects any Connection or Terminal connected to this Terminal Definition at line 57 of file Terminal.cpp.

void syn::Terminal::setHighMark ( unsigned int h ) [inline]

set the high mark. Definition at line 123 of file Terminal.h.

void syn::Terminal::setLowMark ( unsigned int l ) [inline]

set the low mark. Definition at line 126 of file Terminal.h.

unsigned int syn::Terminal::highMark ( ) const [inline]

what is the high mark. Definition at line 129 of file Terminal.h.

unsigned int syn::Terminal::lowMark ( ) const [inline]

what is the low mark. Definition at line 132 of file Terminal.h.

---

The documentation for this class was generated from the following files:

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

---