model-port.hpp

Go to the documentation of this file.

/*
  MODEL-PORT.hpp  -  point to pull output data from the model

  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_MOBJECT_MODEL_PORT_H
#define STEAM_MOBJECT_MODEL_PORT_H

#include "steam/asset/pipe.hpp"
#include "steam/streamtype.hpp"

namespace steam {
namespace mobject {
  
  LUMIERA_ERROR_DECLARE (INVALID_MODEL_PORT);     
  LUMIERA_ERROR_DECLARE (UNCONNECTED_MODEL_PORT); 
  
  
  using asset::ID;
  
  
  class ModelPort
    {
      ID<asset::Pipe> id_;
      
    public:
      ModelPort()                         
        : id_(ID<asset::Pipe>::INVALID)
        { }
      
      ModelPort (ID<asset::Pipe> refID);  
      
      // using default copy operations
      
      
      static bool exists (ID<asset::Pipe>);
      
      ID<asset::Pipe>   pipe()    const;
      ID<asset::Struct> holder()  const;
      StreamType::ID streamType() const;
      
      bool
      isValid()  const
        {
          return exists (this->id_);
        }
      
      explicit
      operator bool()  const
        {
          return isValid();
        }
      
      
      friend bool
      operator== (ModelPort const& mp1, ModelPort const& mp2)
      {
        return mp1.id_ == mp2.id_;
      }
      
      friend bool
      operator!= (ModelPort const& mp1, ModelPort const& mp2)
      {
        return mp1.id_ != mp2.id_;
      }
      
      friend bool
      operator< (ModelPort const& mp1, ModelPort const& mp2)
      {
        return lib::HashVal(mp1.id_) < lib::HashVal(mp2.id_);
      }
      
    private:
      
    };
  
  
  
}} // namespace steam::mobject
#endif