ComponentWrapper.hpp

Go to the documentation of this file.

// Copyright (C) 2010-2013 von Karman Institute for Fluid Dynamics, Belgium
//
// This software is distributed under the terms of the
// GNU Lesser General Public License version 3 (LGPLv3).
// See doc/lgpl.txt and doc/gpl.txt for the license text.

#ifndef cf3_Python_Component_hpp
#define cf3_Python_Component_hpp

#include <boost/python/object.hpp>

#include "common/BasicExceptions.hpp"
#include "common/SignalHandler.hpp"

namespace cf3 {
  namespace common { class Component; }
  template<typename T> class Handle;
namespace python {

struct PythonListInterface
{
  virtual ~PythonListInterface() {}

  virtual Uint len() const = 0;

  virtual boost::python::object get_item(const Uint i) const = 0;

  virtual void set_item(const Uint i, boost::python::object& value) = 0;

  virtual std::string to_str() const = 0;
};
  
class ComponentWrapper
{
public:
  ComponentWrapper(const Handle<common::Component>& component);
  ~ComponentWrapper();

  common::Component& component();

  template<typename ComponentT>
  ComponentT& component()
  {
    ComponentT* comp = dynamic_cast<ComponentT*>(&component());
    if(!comp)
      throw common::CastingFailed(FromHere(), "Could not cast python wrapped object to type " + ComponentT::type_name());

    return *comp;
  }

  void set_list_interface(PythonListInterface* interface);

  PythonListInterface* get_list_interface();

private:
  friend boost::python::object wrap_component(const cf3::Handle<common::Component>&);
  class Implementation;
  boost::shared_ptr<Implementation> m_implementation; // Shared pointer so we can easily make shallow copies
};

void def_component();

boost::python::object wrap_component(const cf3::Handle<common::Component>& component);

} // python
} // cf3


#endif // cf3_Python_Component_hpp