generic_obj.hpp

Go to the documentation of this file.

/*
 *
 *                   _/_/_/    _/_/   _/    _/ _/_/_/    _/_/
 *                  _/   _/ _/    _/ _/_/  _/ _/   _/ _/    _/
 *                 _/_/_/  _/_/_/_/ _/  _/_/ _/   _/ _/_/_/_/
 *                _/      _/    _/ _/    _/ _/   _/ _/    _/
 *               _/      _/    _/ _/    _/ _/_/_/  _/    _/
 *
 *             ***********************************************
 *                              PandA Project
 *                     URL: http://panda.dei.polimi.it
 *                       Politecnico di Milano - DEIB
 *                        System Architectures Group
 *             ***********************************************
 *              Copyright (C) 2004-2024 Politecnico di Milano
 *
 *   This file is part of the PandA framework.
 *
 *   The PandA framework 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */
#ifndef GEN_OBJECT_HPP
#define GEN_OBJECT_HPP

#include "config_HAVE_UNORDERED.hpp"

#include "refcount.hpp"
#include <string>
#include <utility>

REF_FORWARD_DECL(structural_object);

class generic_obj
{
 public:
   enum resource_type
   {
      FUNCTIONAL_UNIT = 0, 
      REGISTER,            
      MULTI_UNBOUNDED_OBJ, 
      COMMAND_PORT,        
      DATA_PORT,           
      CONNECTION_ELEMENT,  
      ADDER_CONN_OBJ,      
      UU_CONV_CONN_OBJ,    
      UI_CONV_CONN_OBJ,    
      IU_CONV_CONN_OBJ,    
      II_CONV_CONN_OBJ,    
      FF_CONV_CONN_OBJ,    
      I_ASSIGN_CONN_OBJ,   
      U_ASSIGN_CONN_OBJ,   
      F_ASSIGN_CONN_OBJ,   
   };

 protected:
   const resource_type type;

   Wrefcount<structural_object> SM;

   Wrefcount<structural_object> out_sign;

   std::string name;

 public:
   generic_obj(const resource_type t, const std::string& _name) : type(t), name(_name)
   {
   }

   virtual ~generic_obj() = default;

   void print(std::ostream& os) const
   {
      os << name;
   }

   friend std::ostream& operator<<(std::ostream& os, const generic_obj& s)
   {
      s.print(os);
      return os;
   }

   const std::string get_string() const
   {
      return name;
   }

   unsigned int get_type() const
   {
      return type;
   }

   void set_structural_obj(const structural_objectRef& SM_)
   {
      SM = SM_;
   }

   void set_out_sign(const structural_objectRef& out_sign_)
   {
      out_sign = out_sign_;
   }

   const structural_objectRef get_structural_obj() const
   {
      return SM.lock();
   }

   const structural_objectRef get_out_sign() const
   {
      return out_sign.lock();
   }

   bool operator<(const generic_obj& other) const;
};

using generic_objRef = refcount<generic_obj>;

#if !HAVE_UNORDERED
class GenericObjSorter : std::binary_function<generic_objRef, generic_objRef, bool>
{
 public:
   GenericObjSorter();

   bool operator()(const generic_objRef& x, const generic_objRef& y) const;
};

class GenericObjUnsignedIntSorter
    : std::binary_function<std::pair<generic_objRef, unsigned int>, std::pair<generic_objRef, unsigned int>, bool>
{
 public:
   GenericObjUnsignedIntSorter();

   bool operator()(const std::pair<generic_objRef, int>& x, const std::pair<generic_objRef, int>& y) const;
};
#endif
#endif