model-port-registry.hpp

Go to the documentation of this file.

/*
    MODEL-PORT-REGISTRY.hpp  -  creating and organising and accessing model ports

  Copyright (C)         Lumiera.org
    2010,               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_MODEL_PORT_REGISTRY_H
#define STEAM_FIXTURE_MODEL_PORT_REGISTRY_H

#include "lib/error.hpp"
#include "lib/optional-ref.hpp"
#include "steam/asset/pipe.hpp"
#include "steam/asset/struct.hpp"
#include "steam/mobject/model-port.hpp"

#include <map>

namespace steam {
namespace fixture {
  
  using asset::ID;
  using asset::Pipe;
  using asset::Struct;
  
  LUMIERA_ERROR_DECLARE (DUPLICATE_MODEL_PORT); 
  
  
  class ModelPortRegistry
    : util::NonCopyable
    {
      
      typedef ID<Pipe>   PID;
      typedef ID<Struct> StID;
      
    public:
      
      class ModelPortDescriptor;
      
      
      static void shutdown ();
      
      static ModelPortRegistry*
      setActiveInstance (ModelPortRegistry& newRegistry);
      
      static ModelPortRegistry&
      globalInstance();
      
      static ModelPortDescriptor const&
      accessDescriptor (PID); 
      
      
      ModelPortDescriptor const&
      definePort (PID pipe, StID element_exposing_this_port);
      
      bool contains (PID)     const;
      bool isRegistered (PID) const;
      
      ModelPortDescriptor const&
      get (PID)  const;
      
      
      void remove (PID);
      void clear();
      
      
      void commit();
      
      void rollback();
      
      
    private:
      static lib::OptionalRef<ModelPortRegistry> theGlobalRegistry;
      
      typedef std::map<PID, ModelPortDescriptor> MPTable;
      
      MPTable currentReg_;
      MPTable transaction_;
    };
  
  
  
  
  class ModelPortRegistry::ModelPortDescriptor
    {
      PID  id_;
      StID holder_;
      
    protected:
      ModelPortDescriptor (PID pipe, StID element_exposing_this_port)
        : id_(pipe)
        , holder_(element_exposing_this_port)
        { }
      
      friend class ModelPortRegistry;
      
    public:
      ModelPortDescriptor()
        : id_(PID::INVALID)
        , holder_(StID::INVALID)
        { }
      
      // default copy operations permitted
      
      bool
      isValid()  const
        {
          return bool(id_);
        }
      
      const PID  id()      const { return id_; }
      const StID holder()  const { return holder_; }
    };
  
  
  
}} // namespace steam::fixture
#endif /*STEAM_FIXTURE_MODEL_PORT_REGISTRY_H*/