mlConnectors.h

Go to the documentation of this file.

// **InsertLicense** code
//-------------------------------------------------------------------------
//-------------------------------------------------------------------------
#ifndef __mlConnectors_H
#define __mlConnectors_H

// ML-includes
#include "mlInitSystemML.h"
#include "mlRuntimeSubClass.h"
#include "mlPagedImage.h"

#ifdef ML_DEPRECATED
#include "mlModule.h"
#endif // ML_DEPRECATED


// 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;

// Disable warnings on own usage of deprecation
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable : 4996 )
#endif

//-------------------------------------------------------------------------
//-------------------------------------------------------------------------
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;
  
  
#ifdef ML_DEPRECATED


  
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 // ML_DEPRECATED
  
};




//-------------------------------------------------------------------------

//-------------------------------------------------------------------------
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;
  
  
#ifdef ML_DEPRECATED


  
public:  
  inline ML_DEPRECATED BaseOp &getOp() const { return *static_cast<BaseOp*>(&getModule()); }
  inline ML_DEPRECATED OutputConnector* getLink() const { return getConnector(); }
  
#endif // ML_DEPRECATED
  
};

// re-enable deprecation warnings
#ifdef _MSC_VER
#pragma warning(pop)
#endif

ML_END_NAMESPACE


#endif // __mlConnectors_H