PortManager.h

Go to the documentation of this file.

/*
   For more information, please see: http://software.sci.utah.edu

   The MIT License

   Copyright (c) 2012 Scientific Computing and Imaging Institute,
   University of Utah.

   License for the specific language governing rights and limitations under
   Permission is hereby granted, free of charge, to any person obtaining a
   copy of this software and associated documentation files (the "Software"),
   to deal in the Software without restriction, including without limitation
   the rights to use, copy, modify, merge, publish, distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so, subject to the following conditions:

   The above copyright notice and this permission notice shall be included
   in all copies or substantial portions of the Software.

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
   OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
   DEALINGS IN THE SOFTWARE.
*/

/// @todo Documentation Dataflow/Network/PortManager.h


#ifndef DATAFLOW_NETWORK_PORTMANAGER_H
#define DATAFLOW_NETWORK_PORTMANAGER_H 

#include <Dataflow/Network/Port.h>
#include <Core/Utils/Exception.h>

#include <boost/foreach.hpp>
#include <boost/range/adaptors.hpp>
#include <boost/range/algorithm/copy.hpp>
#include <string>
#include <map>

namespace SCIRun {
namespace Dataflow {
namespace Networks {

template<class T> 
class PortManager : boost::noncopyable
{
private:
  typedef std::map<PortId, T> PortMap;
  PortMap ports_;
  ModuleInterface* module_;
  
public:
  PortManager();
  size_t size() const;
  size_t add(const T& item);
  void remove(const PortId& id);
  T operator[](const PortId& id) const;
  std::vector<T> operator[](const std::string& name) const;
  bool hasPort(const PortId& id) const;
  void set_module(ModuleInterface* mod) { module_ = mod; }
  std::vector<T> view() const;
};

struct PortOutOfBoundsException : virtual Core::ExceptionBase {};

template<class T>
PortManager<T>::PortManager() :
  module_(0)
{
}

template<class T>
size_t
PortManager<T>::size() const
{ 
  return ports_.size();
}

template<class T>
size_t
PortManager<T>::add(const T& item)
{ 
  ports_[item->id()] = item;
  /// @todo: who should manage port indexes?
  //item->setIndex(size() - 1);
  auto index = size() - 1;
  return index;
}

template<class T>
void
PortManager<T>::remove(const PortId& id)
{
  auto it = ports_.find(id);
  if (it == ports_.end())
  {
    std::ostringstream ostr;
    ostr << "PortManager tried to remove a port that does not exist: " << id;
    BOOST_THROW_EXCEPTION(PortOutOfBoundsException() << Core::ErrorMessage(ostr.str()));
  }
  ports_.erase(it);
  size_t i = 0;
  BOOST_FOREACH(typename PortMap::value_type& portPair, ports_)
    portPair.second->setIndex(i++);
}

template<class T>
T
PortManager<T>::operator[](const PortId& id) const
{
  auto it = ports_.find(id);
  if (it == ports_.end())
  {
    /// @todo: need a way to detect and create arbitrary dynamic ports from serialized files.
    //if (id.dynamic)
    //  std::cout << "DYNAMIC PORT NEEDS TO INSERT ITSELF HERE SOMEHOW" << std::endl;
    //else
    //  std::cout << "HELLO NOT SETTING PORT FLAGS CORRECT" << std::endl;
    std::ostringstream ostr;
    ostr << "PortManager tried to access a port that does not exist: " << id;
    BOOST_THROW_EXCEPTION(PortOutOfBoundsException() << Core::ErrorMessage(ostr.str()));
  }
  return it->second;
}

template<class T>
std::vector<T> PortManager<T>::operator[](const std::string& name) const
{
  std::vector<T> portsWithName;

  boost::copy(
    ports_ | boost::adaptors::map_values 
              | boost::adaptors::filtered([&](const T& port) { return port->get_portname() == name; }), std::back_inserter(portsWithName));

  if (portsWithName.empty())
  {
    BOOST_THROW_EXCEPTION(PortOutOfBoundsException() << Core::ErrorMessage("PortManager does not contain a port by name: " + name));
  }

  return portsWithName;
}

template <class T>
std::vector<T> PortManager<T>::view() const
{
  std::vector<T> portVector;
  boost::copy(ports_ | boost::adaptors::map_values, std::back_inserter(portVector));
  std::sort(portVector.begin(), portVector.end(), [](const T& lhs, const T& rhs) { return lhs->getIndex() < rhs->getIndex(); });
  return portVector;
}

template <class T>
bool PortManager<T>::hasPort(const PortId& id) const
{
  return ports_.find(id) != ports_.end();
}

}}}

#endif