segment.hpp

Go to the documentation of this file.

/*
  SEGMENT.hpp  -  Segment of the timeline for rendering.

  Copyright (C)         Lumiera.org
    2008,               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 STEAM_FIXTURE_SEGMENT_H
#define STEAM_FIXTURE_SEGMENT_H


#include "steam/common.hpp"
#include "steam/fixture/node-graph-attachment.hpp"
#include "steam/mobject/explicitplacement.hpp"
#include "steam/engine/job-ticket.hpp"
#include "lib/allocator-handle.hpp"
#include "lib/time/timevalue.hpp"
#include "lib/util.hpp"

#include <utility>
#include <deque>
#include <tuple>


namespace steam {
namespace fixture {
  
  using mobject::ExplicitPlacement;
  using lib::time::TimeSpan;
  using lib::time::Time;
  using util::unConst;
  using std::move;
  
  class Segment
    {
      using JobTicket   = engine::JobTicket;
      using TicketAlloc = lib::AllocatorHandle<JobTicket>;
      using PortTable   = std::deque<std::reference_wrapper<JobTicket>>;
      
    protected:
      
      TimeSpan span_;
      
      TicketAlloc ticketAlloc_;
      PortTable   portTable_;
      

      std::deque<ExplicitPlacement> elements;
      // TODO: actually necessary??
      // TODO: ownership??
    public:
      explicit
      Segment (TimeSpan span =TimeSpan::ALL) 
        : Segment{span, NodeGraphAttachment{}}
      { }
      
      Segment (TimeSpan covered
              ,NodeGraphAttachment&& modelLink)
        : span_{covered}
        , ticketAlloc_{}
        , portTable_{}
        , exitNode{move (modelLink)}
      { }
      
      Segment (Segment const& original, TimeSpan changed)
        : span_{changed}
        , ticketAlloc_{} // Note: not cloning tickets owned by Segment
        , portTable_{}
        , exitNode{original.exitNode}   
      { }
      
      // default copy acceptable
      
      Time start() const { return span_.start(); }
      Time after() const { return span_.end(); }
      
      NodeGraphAttachment exitNode;
      
      
      engine::JobTicket&
      jobTicket (size_t portNr)  const
        {
          if (portNr >= portTable_.size())
            unConst(this)->generateTickets_onDemand (portNr);
          ASSERT (portNr < portTable_.size());
          return portTable_[portNr];
        }
      
      bool
      empty() const
        {
          return exitNode.empty();
        }
      
      
    private:
      void
      generateTickets_onDemand (size_t portNr)
        {
          for (size_t i = portTable_.size(); i <= portNr; ++i)
            if (isnil (exitNode[portNr]))                      // ‣ disable this slot
                portTable_.emplace_back (engine::JobTicket::NOP);
            else
              {// Ticket was not generated yet...
                JobTicket& newTicket = ticketAlloc_(exitNode[portNr], ticketAlloc_);
                portTable_.emplace_back (newTicket);      // ref to new ticket ‣ slot
              }
        }
    };
  
  
  
}} // namespace steam::fixture
#endif /*STEAM_FIXTURE_SEGMENT_H*/