netmsgs  1.2.2
RoadNarrows Robotics Network Messaging Package
NetMsgsCore.i
1 /******************************************************************************
2  *
3  * Package: NetMsgs
4  *
5  * File: NetMsgsCore.i
6  *
7  * $LastChangedDate$
8  * $Rev$
9  */
10 
11 /*!
12  * \file
13  *
14  * \brief Core NetMsgs python swig interface definitions file.
15  *
16  * \author Robin Knight (robin.knight@roadnarrows.com)
17  *
18  * \par Copyright:
19  * (C) 2010. RoadNarrows LLC.
20  * (http://www.roadnarrows.com)
21  * All Rights Reserved
22  */
23 
24 /*
25  *
26  * Permission is hereby granted, without written agreement and without
27  * license or royalty fees, to use, copy, modify, and distribute this
28  * software and its documentation for any purpose, provided that
29  * (1) The above copyright notice and the following two paragraphs
30  * appear in all copies of the source code and (2) redistributions
31  * including binaries reproduces these notices in the supporting
32  * documentation. Substantial modifications to this software may be
33  * copyrighted by their authors and need not follow the licensing terms
34  * described here, provided that the new terms are clearly indicated in
35  * all files where they apply.
36  *
37  * IN NO EVENT SHALL THE AUTHOR, ROADNARROWS LLC, OR ANY MEMBERS/EMPLOYEES
38  * OF ROADNARROW LLC OR DISTRIBUTORS OF THIS SOFTWARE BE LIABLE TO ANY
39  * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
40  * DAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION,
41  * EVEN IF THE AUTHORS OR ANY OF THE ABOVE PARTIES HAVE BEEN ADVISED OF
42  * THE POSSIBILITY OF SUCH DAMAGE.
43  *
44  * THE AUTHOR AND ROADNARROWS LLC SPECIFICALLY DISCLAIM ANY WARRANTIES,
45  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
46  * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN
47  * "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO
48  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
49  *
50  ******************************************************************************/
51 
52 %module NetMsgsCore
53 %{
54 #include "rnr/netmsgs.h"
55 %}
56 
57 %begin
58 %{
59 /*! \file
60  * \brief Swig generated core wrapper c file.
61  */
62 %}
63 
64 /*
65  * Required RNR C types
66  */
67 typedef unsigned char byte_t;
68 typedef unsigned short ushort_t;
69 typedef unsigned int uint_t;
70 typedef unsigned long ulong_t;
71 typedef int bool_t;
72 
73 /* The swigged interface */
74 %include "rnr/netmsgs.h"
75 
76 /*
77  * Higher-level python interface to the core C library.
78  */
79 %pythoncode
80 %{
81 
82 """
83 NetMsgs Core Python Inline Extensions and Wrappers.
84 """
85 
86 ## \file
87 ## \package NetMsgs.NetMsgsCore
88 ##
89 ## \brief NetMsgs Swigged Core Python Interface Module.
90 ##
91 ## \author Robin Knight (robin.knight@roadnarrows.com)
92 ##
93 ## \par Copyright:
94 ## (C) 2010. RoadNarrows LLC.\n
95 ## (http://www.roadnarrows.com)\n
96 ## All Rights Reserved
97 ##
98 
99 %}