protocol_class.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2006,2008 Free Software Foundation, Inc.
00004  * 
00005  * This file is part of GNU Radio
00006  * 
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  * 
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  * 
00017  * You should have received a copy of the GNU General Public License along
00018  * with this program; if not, write to the Free Software Foundation, Inc.,
00019  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
00020  */
00021 #ifndef INCLUDED_MB_PROTOCOL_CLASS_H
00022 #define INCLUDED_MB_PROTOCOL_CLASS_H
00023 
00024 #include <mblock/common.h>
00025 
00026 /*!
00027  * \brief construct a protocol_class
00028  *
00029  * \param name          the name of the class (symbol)
00030  * \param incoming      incoming message set (list of symbols)
00031  * \param outgoing      outgoing message set (list of symbols)
00032  */
00033 pmt_t mb_make_protocol_class(pmt_t name, pmt_t incoming, pmt_t outgoing);
00034 
00035 // Accessors
00036 pmt_t mb_protocol_class_name(pmt_t pc);         //< return name of protocol class
00037 pmt_t mb_protocol_class_incoming(pmt_t pc);     //< return incoming message set
00038 pmt_t mb_protocol_class_outgoing(pmt_t pc);     //< return outgoing message set
00039 
00040 pmt_t mb_protocol_class_lookup(pmt_t name);     //< lookup an existing protocol class by name
00041 
00042 
00043 /*!
00044  * \brief Initialize one or more protocol class from a serialized description.
00045  * Used by machine generated code.
00046  */
00047 class mb_protocol_class_init {
00048 public:
00049   mb_protocol_class_init(const char *data, size_t len);
00050 };
00051 
00052 #endif /* INCLUDED_MB_PROTOCOL_CLASS_H */

Generated on Wed Jul 29 06:31:39 2009 for GNU Radio 3.2.2 C++ API by  doxygen 1.5.9