ML Reference
ml::OutputConnector Class Reference

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

#include <mlConnectors.h>

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.
 
ModulegetModule () 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.
 
InputConnectorgetConnector (MLint i) const
 Returns InputConnector with index i.
 
PagedImagegetImage ()
 Returns the paged image of this connector.
 

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 46 of file mlConnectors.h.

Constructor & Destructor Documentation

◆ OutputConnector()

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

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

◆ ~OutputConnector()

virtual ml::OutputConnector::~OutputConnector ( )
virtual

Destructor: Destroy this and disconnects connections from all InputConnectors.

Member Function Documentation

◆ getConnector()

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

Returns InputConnector with index i.

◆ getImage()

PagedImage & ml::OutputConnector::getImage ( )

Returns the paged image of this connector.

◆ getIndex()

MLint ml::OutputConnector::getIndex ( ) const

Returns output index of of this connector on the Module.

◆ getModule()

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

Returns module to which this connector belongs to.

◆ getNumConnectors()

MLint ml::OutputConnector::getNumConnectors ( ) const

Returns number of connected InputConnectors.

Friends And Related Symbol Documentation

◆ InputConnector

friend class InputConnector
friend

Permits accesses of inputConnector to this (OutputConnector).

Definition at line 108 of file mlConnectors.h.


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