---

FilterConnection< SAMPLE > Class Template Reference

#include <FilterConnection.h>

Inheritance diagram for FilterConnection< SAMPLE >:

[legend]Collaboration diagram for FilterConnection< SAMPLE >:

[legend]List of all members.

---

Detailed Description

template<class SAMPLE>
class FilterConnection< SAMPLE >

FilterConnection Interface (5.1.1.2) Inherits from Connection.

connectFrom(conn:Connection) Accepts a connection FROM conn connection. The current filterConnection accepts the connection as an input to the connection. process() A step taken which will read in data and output data, fills and dumps one buffer. Must be called to move audio. disconnectFrom(conn:Connection) Disconnects an incoming patch between the current connection and "conn" connection. disconnectTo(conn:Connection)Disconnects an outgoing patch between current connection and "conn" connection.

Definition at line 25 of file FilterConnection.h.

Public Methods
void	connectFrom (Connection< SAMPLE > &conn)
	connectFrom Accepts a connection FROM conn connection.
void	connectFrom (Connection< SAMPLE > *conn)
	connectFrom Accepts a connection FROM conn connection.
virtual void	process ()
	Process, reads and write data from other connections.
void	disconnectFrom (Connection< SAMPLE > *conn)
	disconnectFrom Disconnects an incoming patch between the current connection and "conn" connection.
void	disconnectTo (FilterConnection< SAMPLE > *conn)
	disconnectTo Disconnects an outgoing patch between current and conn
virtual string	xmlType ()
	used for XML output gets the type of the FilterConnection
string *	getXML ()
	gets an XML representation of the current instance.
virtual int	read (SAMPLE *data, int size)
	read size samples into data from the Connection
	FilterConnection (BufferedFile *fd)
	Constructor using a bufferedfile.
	FilterConnection (BufferedFile *fd, string name)
	Constructor using a bufferedfile and name.
virtual	~FilterConnection ()
	Destructor.
Public Attributes
int	lastClock
	the lastClock value remembered.
Protected Methods
void	initBuffer ()
virtual void	disconnect ()
	Disconnect the current connection.
Protected Attributes
vector< Connection< SAMPLE > * >	inConnections
SAMPLE *	buffer
SAMPLE *	buffer2
SAMPLE *	buffer3

---

Constructor & Destructor Documentation

template<class SAMPLE> FilterConnection< SAMPLE >::FilterConnection (  BufferedFile *    fd )  [inline]

Constructor using a bufferedfile. Definition at line 148 of file FilterConnection.h.

template<class SAMPLE> FilterConnection< SAMPLE >::FilterConnection (  BufferedFile *    fd, string    name )  [inline]

Constructor using a bufferedfile and name. Definition at line 155 of file FilterConnection.h.

template<class SAMPLE> virtual FilterConnection< SAMPLE >::~FilterConnection (    )  [inline, virtual]

Destructor. Definition at line 162 of file FilterConnection.h.

---

Member Function Documentation

template<class SAMPLE> void FilterConnection< SAMPLE >::connectFrom (  Connection< SAMPLE > *    conn )  [inline]

connectFrom Accepts a connection FROM conn connection. Definition at line 37 of file FilterConnection.h.

template<class SAMPLE> void FilterConnection< SAMPLE >::connectFrom (  Connection< SAMPLE > &    conn )  [inline]

connectFrom Accepts a connection FROM conn connection. Essentially a compatibility wrapper Definition at line 31 of file FilterConnection.h. Referenced by FilterConnection< char >::connectFrom().

template<class SAMPLE> virtual void FilterConnection< SAMPLE >::disconnect (    )  [inline, protected, virtual]

Disconnect the current connection. Reimplemented from Connection< SAMPLE >. Definition at line 183 of file FilterConnection.h. Referenced by FilterConnection< char >::~FilterConnection().

template<class SAMPLE> void FilterConnection< SAMPLE >::disconnectFrom (  Connection< SAMPLE > *    conn )  [inline]

disconnectFrom Disconnects an incoming patch between the current connection and "conn" connection. Definition at line 87 of file FilterConnection.h. Referenced by FilterConnection< char >::disconnectTo(), and FilterConnection< char >::process().

template<class SAMPLE> void FilterConnection< SAMPLE >::disconnectTo (  FilterConnection< SAMPLE > *    conn )  [inline]

disconnectTo Disconnects an outgoing patch between current and conn Definition at line 99 of file FilterConnection.h.

template<class SAMPLE> string* FilterConnection< SAMPLE >::getXML (    )  [inline]

gets an XML representation of the current instance. Definition at line 111 of file FilterConnection.h.

template<class SAMPLE> void FilterConnection< SAMPLE >::initBuffer (    )  [inline, protected]

Definition at line 173 of file FilterConnection.h. Referenced by FilterConnection< char >::FilterConnection().

template<class SAMPLE> virtual void FilterConnection< SAMPLE >::process (    )  [inline, virtual]

Process, reads and write data from other connections. Reimplemented in InputConnection< SAMPLE >, and OutputConnection< SAMPLE >. Definition at line 47 of file FilterConnection.h. Referenced by OutputConnection< SAMPLE >::process().

template<class SAMPLE> virtual int FilterConnection< SAMPLE >::read (  SAMPLE *    data, int    size )  [inline, virtual]

read size samples into data from the Connection Reimplemented from Connection< SAMPLE >. Definition at line 137 of file FilterConnection.h.

template<class SAMPLE> virtual string FilterConnection< SAMPLE >::xmlType (    )  [inline, virtual]

used for XML output gets the type of the FilterConnection Reimplemented in OutputConnection< SAMPLE >. Definition at line 105 of file FilterConnection.h. Referenced by FilterConnection< char >::getXML().

---

Member Data Documentation

template<class SAMPLE> SAMPLE* FilterConnection< SAMPLE >::buffer [protected]

Definition at line 170 of file FilterConnection.h. Referenced by FilterConnection< char >::initBuffer(), FilterConnection< char >::process(), and FilterConnection< char >::~FilterConnection().

template<class SAMPLE> SAMPLE* FilterConnection< SAMPLE >::buffer2 [protected]

Definition at line 171 of file FilterConnection.h. Referenced by FilterConnection< char >::initBuffer(), and FilterConnection< char >::process().

template<class SAMPLE> SAMPLE* FilterConnection< SAMPLE >::buffer3 [protected]

Definition at line 172 of file FilterConnection.h. Referenced by FilterConnection< char >::initBuffer(), and FilterConnection< char >::read().

template<class SAMPLE> vector<Connection<SAMPLE>*> FilterConnection< SAMPLE >::inConnections [protected]

Definition at line 169 of file FilterConnection.h. Referenced by FilterConnection< char >::connectFrom(), FilterConnection< char >::disconnect(), FilterConnection< char >::disconnectFrom(), FilterConnection< char >::FilterConnection(), FilterConnection< char >::getXML(), FilterConnection< char >::process(), and FilterConnection< char >::~FilterConnection().

template<class SAMPLE> int FilterConnection< SAMPLE >::lastClock

the lastClock value remembered. Definition at line 136 of file FilterConnection.h. Referenced by FilterConnection< char >::initBuffer(), and FilterConnection< char >::read().

---

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

• FilterConnection.h

---