ML Reference
Public Member Functions | Friends
ml::OutputConnector Class Reference

Class to manage an output connection for a Module module. More...

#include <mlConnectors.h>

List of all members.

Public Member Functions

 OutputConnector (Module &module, MLint index)
 Constructor: Create output image connection for module module and output index index.
virtual ~OutputConnector ()
 Destructor: Destroy this and disconnects connections from all InputConnectors.
Module & getModule () const
 Returns module to which this connector belongs to.
MLint getIndex () const
 Returns output index of of this connector on the Module.
MLint getNumConnectors () const
 Returns number of connected InputConnectors.
InputConnector * getConnector (MLint i) const
 Returns InputConnector with index i.
PagedImage & getImage ()
 Returns the paged image of this connector.
Deprecated
BaseOp & getOp () const
InputConnector * getLink (MLint i) const
MLint getLinkNum () const
PagedImg & getPagedImg ()

Friends

class InputConnector
 Permits accesses of inputConnector to this (OutputConnector).

Detailed Description

Class to manage an output connection for a Module module.

One or more instances of this connector type belong to the Module module thisOp. The number of OutputConnector instances define the number of output images of thisOp. Each instance represents an output image of the Module module and represents the connection with one or more InputConnectors of other Module modules.

Definition at line 58 of file mlConnectors.h.

Constructor & Destructor Documentation

ml::OutputConnector::OutputConnector ( Module &  module,
MLint  index 
)

Constructor: Create output image connection for module module and output index index.

virtual ml::OutputConnector::~OutputConnector ( ) [virtual]

Destructor: Destroy this and disconnects connections from all InputConnectors.

Member Function Documentation

InputConnector* ml::OutputConnector::getConnector ( MLint  i) const

Returns InputConnector with index i.

PagedImage& ml::OutputConnector::getImage ( )

Returns the paged image of this connector.

MLint ml::OutputConnector::getIndex ( ) const

Returns output index of of this connector on the Module.

InputConnector* ml::OutputConnector::getLink ( MLint  i) const [inline]
Deprecated:
Use getConnector() instead.

Definition at line 135 of file mlConnectors.h.

MLint ml::OutputConnector::getLinkNum ( ) const [inline]
Deprecated:
Use getNumConnections() instead.

Definition at line 138 of file mlConnectors.h.

Module& ml::OutputConnector::getModule ( ) const

Returns module to which this connector belongs to.

MLint ml::OutputConnector::getNumConnectors ( ) const

Returns number of connected InputConnectors.

BaseOp& ml::OutputConnector::getOp ( ) const [inline]
Deprecated:
Use getModule() instead.

Definition at line 132 of file mlConnectors.h.

PagedImg& ml::OutputConnector::getPagedImg ( ) [inline]
Deprecated:
Use getImage() instead.

Definition at line 141 of file mlConnectors.h.

Friends And Related Function Documentation

friend class InputConnector [friend]

Permits accesses of inputConnector to this (OutputConnector).

Definition at line 120 of file mlConnectors.h.

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