• Site en Français
• English Site
• Doc

MPort Class Reference

An abstract module port.

#include <MPort.h>

Inheritance diagram for MPort:

List of all members.

Signals
void	Connected (MPort *port)
void	Disconnected (MPort *port)
Public Member Functions
virtual string	Name () const
virtual string	FullName () const
virtual float *	Buffer ()=0
virtual MModule *	Module () const
virtual bool	IsAudio () const =0
virtual bool	IsControl () const =0
virtual bool	IsInput () const =0
virtual bool	IsOutput () const =0
virtual bool	IsConnectedTo (const MPort *port) const =0
virtual unsigned int	NumberOfConnections () const =0
virtual MPort *	Connection (const unsigned int n) const =0
Protected Member Functions
	MPort (string name, MModule *module)
Protected Attributes
string	_name
MModule *	_module

---

Constructor & Destructor Documentation

MPort::MPort (  string  name, MModule *  module )  [inline, protected]

Creates a port called name and belonging to the module module.

---

Member Function Documentation

string MPort::Name (   )  const [virtual]

The name of the port.

string MPort::FullName (   )  const [virtual]

The full name of the port. The full name of the port is given according to the format : module_name::port_name. Reimplemented in MExternalAudioInputPort.

virtual float* MPort::Buffer (   )  [pure virtual]

The buffer associated with the port. Returns: The buffer of data associated with the port this buffer can be : read in case of output port written to in case of input port. Implemented in MClientAudioInputPort, MClientAudioOutputPort, MExternalAudioInputPort, MPluginAudioInputPort, MPluginAudioOutputPort, MPluginControlInputPort, and MPluginControlOutputPort.

MModule * MPort::Module (   )  const [virtual]

The module owning the port.

virtual bool MPort::IsAudio (   )  const [pure virtual]

Is the port an audio port ? Implemented in MAudioInputPort, MAudioOutputPort, MControlInputPort, and MControlOutputPort.

virtual bool MPort::IsControl (   )  const [pure virtual]

Is the port a control port ? Implemented in MAudioInputPort, MAudioOutputPort, MControlInputPort, and MControlOutputPort.

virtual bool MPort::IsInput (   )  const [pure virtual]

Is the port an input port ? Implemented in MAudioInputPort, MAudioOutputPort, MControlInputPort, and MControlOutputPort.

virtual bool MPort::IsOutput (   )  const [pure virtual]

Is the port an output port ? Implemented in MAudioInputPort, MAudioOutputPort, MControlInputPort, and MControlOutputPort.

virtual bool MPort::IsConnectedTo (  const MPort *  port  )  const [pure virtual]

Is the port connected to port ? Implemented in MAudioInputPort, MAudioOutputPort, MControlInputPort, and MControlOutputPort.

virtual unsigned int MPort::NumberOfConnections (   )  const [pure virtual]

The number of ports connected from or to this port. Implemented in MAudioInputPort, MAudioOutputPort, MControlInputPort, and MControlOutputPort.

virtual MPort* MPort::Connection (  const unsigned int  n  )  const [pure virtual]

The nth port connected to this port. Returns: A pointer to the nth port connected to this port. Precondition: n < NumberOfConnections( ) Postcondition: result != NULL Implemented in MAudioInputPort, MAudioOutputPort, MControlInputPort, and MControlOutputPort.

void MPort::Connected (  MPort *  port  )  [signal]

Signal that this port was connected to port.

void MPort::Disconnected (  MPort *  port  )  [signal]

Signal that this port was disconnected from port.

---

Member Data Documentation

string MPort::_name [protected]

The name of the port.

MModule* MPort::_module [protected]

The module owning the port.

---

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

• MPort.h
• MPort.cpp

---