git.gag.com Git - debian/gnuradio/blob - mblock/src/lib/mb_endpoint.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2006,2008 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GNU Radio
   6  *
   7  * GNU Radio is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 3, or (at your option)
  10  * any later version.
  11  *
  12  * GNU Radio is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #ifndef INCLUDED_MB_ENDPOINT_H
  23 #define INCLUDED_MB_ENDPOINT_H
  24
  25 #include <string>
  26 #include <mblock/port.h>
  27
  28 /*!
  29  * \brief Endpoint specification for connection
  30  */
  31 class mb_endpoint
  32 {
  33   std::string   d_component_name;
  34   std::string   d_port_name;
  35   mb_port_sptr  d_port;                 // the port object that this maps to
  36
  37 public:
  38   mb_endpoint(){}
  39
  40   mb_endpoint(const std::string &component_name,
  41               const std::string &port_name,
  42               mb_port_sptr port)
  43     : d_component_name(component_name),
  44       d_port_name(port_name),
  45       d_port(port) {}
  46
  47   const std::string &component_name() const { return d_component_name; }
  48   const std::string &port_name() const { return d_port_name; }
  49   mb_port_sptr port() const { return d_port; }
  50
  51   //! Does this endpoint represent the inside of a relay port
  52   bool inside_of_relay_port_p() const;
  53
  54   pmt_t incoming_message_set() const;
  55   pmt_t outgoing_message_set() const;
  56 };
  57
  58 #endif /* INCLUDED_MB_ENDPOINT_H */