• Site en Français
• English Site
• Doc

MControlInputPort Class Reference

An abstract control input port.

#include <MControlInputPort.h>

Inheritance diagram for MControlInputPort:

List of all members.

Public Slots
virtual bool	Connect (MControlOutputPort *port)=0
virtual bool	Disconnect (MControlOutputPort *port)=0
Public Member Functions
virtual bool	IsAudio () const
virtual bool	IsControl () const
virtual bool	IsInput () const
virtual bool	IsOutput () const
virtual bool	IsConnectedTo (const MPort *port) const
virtual unsigned int	NumberOfConnections () const
virtual MPort *	Connection (const unsigned int n) const
Protected Member Functions
	MControlInputPort (string name, MModule *module)
Protected Attributes
vector< MControlOutputPort * >	_connection

---

Constructor & Destructor Documentation

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

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

---

Member Function Documentation

virtual bool MControlInputPort::IsAudio (   )  const [inline, virtual]

Is the port an audio port ? Returns: FALSE Implements MPort.

virtual bool MControlInputPort::IsControl (   )  const [inline, virtual]

Is the port a control port ? Returns: TRUE Implements MPort.

virtual bool MControlInputPort::IsInput (   )  const [inline, virtual]

Is the port an input port ? Returns: TRUE Implements MPort.

virtual bool MControlInputPort::IsOutput (   )  const [inline, virtual]

Is the port an output port ? Returns: FALSE Implements MPort.

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

Is the port connected to port ? Implements MPort.

unsigned int MControlInputPort::NumberOfConnections (   )  const [virtual]

The number of ports connected from or to this port. Implements MPort.

MPort * MControlInputPort::Connection (  const unsigned int  n  )  const [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 Implements MPort.

virtual bool MControlInputPort::Connect (  MControlOutputPort *  port  )  [pure virtual, slot]

Tries to connect port to this port. Returns: TRUE if the connection was successfully established else returns FALSE. Precondition: ! IsConnectedTo( port ) Implemented in MClientControlInputPort, and MPluginControlInputPort.

virtual bool MControlInputPort::Disconnect (  MControlOutputPort *  port  )  [pure virtual, slot]

Tries to disconnect port from this port. Returns: TRUE if the ports were actually disconnected else returns FALSE ( the ports were probably not connected ). Postcondition: ! IsConnectedTo( port ) Implemented in MClientControlInputPort, and MPluginControlInputPort.

---

Member Data Documentation

vector< MControlOutputPort * > MControlInputPort::_connection [protected]

The control output ports connected to this port.

---

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

• MControlInputPort.h
• MControlInputPort.cpp

---