mlConnectors.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_CONNECTORS_H
#define ML_CONNECTORS_H

 
// ML-includes
#include "mlInitSystemML.h"
#include "mlRuntimeSubClass.h"
#include "mlPagedImage.h"
 
// Namespace ML. It is recommended that all ML classes and modules reside in this
// namespace to avoid collisions with types from other libraries.
ML_START_NAMESPACE

class Module;
class InputConnector;
 
//-------------------------------------------------------------------------
//-------------------------------------------------------------------------
class MLEXPORT OutputConnector
{
 
public:

  OutputConnector(Module& module, MLint index);

  virtual ~OutputConnector();

  Module& getModule() const;

  MLint getIndex() const;

  MLint getNumConnectors() const;

  InputConnector* getConnector(MLint i) const;

  PagedImage& getImage();
 
private:

  OutputConnector(const OutputConnector &);

  OutputConnector& operator=(const OutputConnector &);

  void           _addLink(InputConnector& link);

  MLint          _removeLink(InputConnector& link);

  MLint          _isLink(const InputConnector& link) const;
 
 
  // --- Members:

  Module        *_module;

  MLint          _thisIndex;

  PagedImage       _pagedImg;

  std::vector <InputConnector*> _inLinkList;

  friend class InputConnector;
};
 
 
 
 
//-------------------------------------------------------------------------

//-------------------------------------------------------------------------
class MLEXPORT InputConnector
{
 
public:

  InputConnector(Module& module, MLint index);

  InputConnector(Module& module, MLint index, OutputConnector& outputConnector);

  virtual ~InputConnector();

  Module& getModule() const;

  MLint getIndex() const;

  OutputConnector* getConnector() const;

  void connect(OutputConnector& connector);

  void disconnect();

  bool isValidConnection() const;
 
private:
  friend class OutputConnector;

  InputConnector(const InputConnector &);

  InputConnector& operator=(const InputConnector &);
 
 
  // --- Members:

  Module          *_module;

  MLint            _thisIndex;

  OutputConnector *_outLink;
};
 
ML_END_NAMESPACE
 
 
#endif