netmsgs  1.2.2
RoadNarrows Robotics Network Messaging Package
__init__.py
Go to the documentation of this file.
1 ################################################################################
2 #
3 # __init__.py
4 #
5 
6 """ RoadNarrows Robotics NetMsgs Generation Tools.
7 
8 The NetMsgs python module provides the set of tools to generate
9 language-specific packing and unpacking routines, plus run-time message
10 processing routines. The generated output is specified from RoadNarrows
11 NetMsgs XML input files.
12 
13 Supported Output Language Generation:
14  C <name>.h and <name>.c
15  Python <name>.py
16 
17 Public Modules:
18  NetMsgCore - Swigged core interface.
19  NetMsgBase - Base data and utilities.
20  NetMsgsGenC - Generate C .h and .c files from XML specification.
21  NetMsgsGenPy - Generate Python .py file from XML specification.
22  NetMsgsLib - Run-Time library packing/unpacking base functions.
23  NetMsgsLibFlat - Run-Time library packing/unpacking derived flat class.
24  NetMsgsLibITV - Run-Time library packing/unpacking derived ITV class.
25  NetMsgsLibStreamBuf - Run-Time library packing/unpacking base class.
26  NetMsgsXmlParser - XML parser for NetMsgs XML.
27 
28 Author: Robin D. Knight
29 Email: robin.knight@roadnarrows.com
30 URL: http://www.roadnarrows.com
31 
32 Copyright (C) 2009-2010. RoadNarrows LLC.
33 All Rights Reserved
34 
35 $LastChangedDate: 2010-08-04 15:07:55 -0600 (Wed, 04 Aug 2010) $
36 $Rev: 550 $
37 """
38 
39 ## \file
40 ## \package NetMsgs
41 ##
42 ## $LastChangedDate: 2010-08-04 15:07:55 -0600 (Wed, 04 Aug 2010) $
43 ## $Rev: 550 $
44 ##
45 ## \brief NetMsgs Base Data Module
46 ##
47 ## \sa
48 ## \htmlonly
49 ## <a href="../pydoc/NetMsgs.html">PyDoc Generated Documentation</a>
50 ## \endhtmlonly
51 ##
52 ## \author Robin Knight (robin.knight@roadnarrows.com)
53 ##
54 ## \par Copyright:
55 ## (C) 2009-2010. RoadNarrows LLC.\n
56 ## (http://www.roadnarrows.com)\n
57 ## All Rights Reserved
58 ##
59 
60 #
61 # Permission is hereby granted, without written agreement and without
62 # license or royalty fees, to use, copy, modify, and distribute this
63 # software and its documentation for any purpose, provided that
64 # (1) The above copyright notice and the following two paragraphs
65 # appear in all copies of the source code and (2) redistributions
66 # including binaries reproduces these notices in the supporting
67 # documentation. Substantial modifications to this software may be
68 # copyrighted by their authors and need not follow the licensing terms
69 # described here, provided that the new terms are clearly indicated in
70 # all files where they apply.
71 #
72 # IN NO EVENT SHALL THE AUTHOR, ROADNARROWS LLC, OR ANY MEMBERS/EMPLOYEES
73 # OF ROADNARROW LLC OR DISTRIBUTORS OF THIS SOFTWARE BE LIABLE TO ANY
74 # PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
75 # DAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION,
76 # EVEN IF THE AUTHORS OR ANY OF THE ABOVE PARTIES HAVE BEEN ADVISED OF
77 # THE POSSIBILITY OF SUCH DAMAGE.
78 #
79 # THE AUTHOR AND ROADNARROWS LLC SPECIFICALLY DISCLAIM ANY WARRANTIES,
80 # INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
81 # FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN
82 # "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO
83 # PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
84 #
85 ################################################################################
86 
87 ## All modules in NetMsgs package.
88 __all__ = [
89  'NetMsgsCore',
90  'NetMsgsBase',
91  'NetMsgsGenC',
92  'NetMsgsGenPy',
93  'NetMsgsLib',
94  'NetMsgsLibFlat',
95  'NetMsgsLibITV',
96  'NetMsgsLibStreamBuf',
97  'NetMsgsXmlParser',
98 ]