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"
 
#if ML_DEPRECATED_SINCE(3,5,0)
#include "mlModule.h"
#endif
 
 
// Namespace ML. It is recommended that all ML classes and modules are in this
// name space to avoid collisions with types of 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;
 
 
#if ML_DEPRECATED_SINCE(3,5,0)
 
 
public:
 
  inline ML_DEPRECATED BaseOp& getOp() const { return *static_cast<BaseOp*>(&getModule()); }
  inline ML_DEPRECATED InputConnector* getLink(MLint i) const { return getConnector(i); }
  inline ML_DEPRECATED MLint getLinkNum() const { return getNumConnectors(); }
  inline ML_DEPRECATED PagedImg& getPagedImg() { return getImage(); }
 
#endif
 
};
 
 
 
 
//-------------------------------------------------------------------------
 
//-------------------------------------------------------------------------
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;
 
 
#if ML_DEPRECATED_SINCE(3,5,0)
 
 
public:
  inline ML_DEPRECATED BaseOp &getOp() const { return *static_cast<BaseOp*>(&getModule()); }
  inline ML_DEPRECATED OutputConnector* getLink() const { return getConnector(); }
 
#endif
 
};
 
ML_END_NAMESPACE
 
 
#endif