nodewiring-def.hpp

Go to the documentation of this file.

/*
  NODEWIRING-DEF.hpp  -  Implementation of the node network and operation control

  Copyright (C)         Lumiera.org
    2009,               Hermann Vosseler <Ichthyostega@web.de>

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of
  the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef ENGINE_NODEWIRING_DEF_H
#define ENGINE_NODEWIRING_DEF_H


#include "steam/engine/procnode.hpp"
#include "lib/ref-array.hpp"
#include "lib/util-foreach.hpp"
#include "lib/nocopy.hpp"



namespace steam {
namespace engine {
  
  using lib::RefArray;
  
  
  class WiringSituation
    : util::NonCopyable
    {
      long flags_;
      asset::Proc::ProcFunc* function_;
      
    public: /* === API for querying collected data === */
      RefArray<ChannelDescriptor>&
      makeOutDescriptor()  const
        {
          UNIMPLEMENTED ("build new output descriptors for the node under construction");  
        }
      
      RefArray<InChanDescriptor>&
      makeInDescriptor()   const
        {
          UNIMPLEMENTED ("build new input descriptors for the node under construction");
        }
      
      WiringDescriptor::ProcFunc*
      resolveProcessingFunction()  const
        {
          REQUIRE (function_);
          return function_;
        }
      
      lumiera::NodeID const&
      createNodeID()  const
        {
          UNIMPLEMENTED ("initiate generation of a new unique node-ID"); // see rendergraph.cpp
        }
      
      
      
    public: /* === API for specifying the desired wiring === */
      
      WiringSituation()
        : flags_(0)
        , function_(0)
        {
          UNIMPLEMENTED ("representation of the intended wiring");
        }
      
      
      WiringSituation (PNode predecessor)
        : flags_(0)
        , function_(0)
        {
          UNIMPLEMENTED ("wiring representation; hook up connections 1:1");
          REQUIRE (predecessor);
          
          // for_each (predecessor->outputs(), .....   see also Ticket 183 (invoking member fun in for_each)
          
        }
      
      
      WiringSituation&
      defineInput (uint inPin, PNode pred, uint outPin)
        {
          UNIMPLEMENTED ("wiring representation; define new connection");
          return *this;
        }
      
      WiringSituation&
      defineInput (PNode pred, uint outPin)
        {
          UNIMPLEMENTED ("wiring representation; define new connection");
          return *this;
        }
      
      WiringSituation&
      defineInput (uint inPin, PNode pred)
        {
          UNIMPLEMENTED ("wiring representation; define new connection");
          return *this;
        }
      
      
      WiringSituation&
      setFlag (long code)
        {
          flags_ |= code;
          return *this;
        }
      
      long getFlags ()  const { return flags_; }
      
      
      WiringSituation&
      resolveProcessor (asset::Proc const& procAsset)
        {
          function_ = procAsset.resolveProcessor();
          ENSURE (function_);
        }
      
    };
  
  
  
}} // namespace steam::engine
#endif