AstroMsgs.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE netmsgs PUBLIC "-//www.roadnarrows.com//DTD NETMSGS 1.0//EN"
          "http://www.roadnarrows.com/xml/netmsgs/1.0/netmsgs.dtd">

<!--
 - Package:   netmsgs
 -
 - Program:   nmExample
 -
 - File: AstroMsg.xml
 -

/*!
 \file

  $LastChangedDate$
  $Rev$

  \brief Example RoadNarrows NetMsgs XML definitions.
  
  \author Robin Knight (robin.knight@roadnarrows.com)
  
 -  \copyright
 -    \h_copy 2010-2017. RoadNarrows LLC.\n
 -    http://www.roadnarrows.com\n
 -    All Rights Reserved
*/

 - Permission is hereby granted, without written agreement and without
 - license or royalty fees, to use, copy, modify, and distribute this
 - software and its documentation for any purpose, provided that
 - (1) The above copyright notice and the following two paragraphs
 - appear in all copies of the source code and (2) redistributions
 - including binaries reproduces these notices in the supporting
 - documentation.   Substantial modifications to this software may be
 - copyrighted by their authors and need not follow the licensing terms
 - described here, provided that the new terms are clearly indicated in
 - all files where they apply.
 -
 - IN NO EVENT SHALL THE AUTHOR, ROADNARROWS LLC, OR ANY MEMBERS/EMPLOYEES
 - OF ROADNARROW LLC OR DISTRIBUTORS OF THIS SOFTWARE BE LIABLE TO ANY
 - PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
 - DAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION,
 - EVEN IF THE AUTHORS OR ANY OF THE ABOVE PARTIES HAVE BEEN ADVISED OF
 - THE POSSIBILITY OF SUCH DAMAGE.
 -
 - THE AUTHOR AND ROADNARROWS LLC SPECIFICALLY DISCLAIM ANY WARRANTIES,
 - INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 - FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN
 - "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO
 - PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 -
-->

<netmsgs encoding="itv" endian="big">
  <!-- ........................................................................
    - Meta Data to Tweak Source Generation
    ....................................................................... -->
  <meta>
    <brief>Example ITV XML Definitions</brief>
    <ns>Astro</ns>
    <prologue lang="h">
#include "nmExample.h"
    </prologue>
    <epilogue lang="h"></epilogue>
    <prologue lang="c"></prologue>
    <epilogue lang="c"></epilogue>
    <prologue lang="python">
## Minimum star temperature
STAR_TEMP_K_MIN = 1000

## Maximum star temperature
STAR_TEMP_K_MAX = 50000

#
# Star constellation designations are greek leters from brightest to dimmest
#

## 1st star
ALPHA   =   0     

## 2nd star
BETA    =   1     

## 3rd star
GAMMA   =   2     

## 4th star
DELTA   =   3     

## 5th star
EPSILON =   4     

## 6th star
ZETA    =   5     

## 7th star
ETA     =   6     

## 8th star
THETA   =   7     

## 9th star
IOTA    =   8     

## 10th star
KAPPA   =   9     

## 11th star
LAMBDA  =  10     

## 12th star
MU      =  11     

## 13th star
NU      =  12     

## 14th star
XI      =  13     

## 15th star
OMICRON =  14     

## 16th star
PI      =  15     
    </prologue>
    <epilogue lang="python"></epilogue>
  </meta>

  <!-- ........................................................................
    - Extended Field Types (Optional)
    ....................................................................... -->

  <field_types>
    <ftypedef ftid="SpectralClass" ftype="char" />

    <ftypedef ftid="SpectralColor" ftype='string' size="16" />

    <ftypedef ftid="TempK" ftype="u32" />

    <ftypedef ftid="Star" ftype="struct">
      <fielddef fname="Name" ftype="string" size="32" />
      <fielddef fname="Type" ftype="SpectralClass" />
      <fielddef fname="Color" ftype="SpectralColor" />
      <fielddef fname="TempK" ftype="TempK">
        <min>STAR_TEMP_K_MIN</min>
        <max>STAR_TEMP_K_MAX</max>
      </fielddef>
      <fielddef fname="MassSun" ftype="f32">
        <min>0.1</min>
        <max>100.0</max>
      </fielddef>
    </ftypedef>

    <ftypedef ftid="Sun" ftype="Star" />

    <ftypedef ftid="StarGroup" ftype="Star[]" size="16" />

    <ftypedef ftid="Constellation" ftype="struct">
      <fielddef fname="Name" ftype="string" size="32" />
      <fielddef fname="OldName" ftype="string" disposition="deprecated" />
      <fielddef fname="Designation" ftype="u8[]" size="16">
        <min>ALPHA</min>
        <max>PI</max>
      </fielddef>
      <fielddef fname="Star" ftype="StarGroup" />
    </ftypedef>
  </field_types>


  <!-- ........................................................................
    - Message Definitions
    ....................................................................... -->

  <msg_types>
    <!-- Ok Response -->
    <msgdef msgid="RspOk">
    </msgdef>

    <!-- Error Response -->
    <msgdef msgid="RspErr">
      <fielddef fname="ECode" ftype="u8" />
      <fielddef fname="EMsg" ftype="string">
      </fielddef>
    </msgdef>

    <!-- Zodiac Constellatio Family Command -->
    <msgdef msgid="CmdZodiac">
      <fielddef fname="Family" ftype="string" size="32" >
        <const>"Zodiac"</const></fielddef>
      <fielddef fname="Constellation" ftype="Constellation" />
    </msgdef>
  
    <!-- Ursa Major Constellatio Family Command -->
    <msgdef msgid="CmdUrsa">
      <fielddef fname="Family" ftype="string" size="32">
        <const>"Ursa Major"</const>
      </fielddef>
      <fielddef fname="Constellation" ftype="Constellation" />
    </msgdef>
  
    <!-- Music of the Spheres Command -->
    <msgdef msgid="CmdMusicOfTheSpheres" disposition="deprecated">
      <fielddef fname="geometry" ftype="u32" />
      <fielddef fname="cosmology" ftype="u32" />
      <fielddef fname="astrology" ftype="u32" />
      <fielddef fname="harmonics" ftype="u32" />
      <fielddef fname="music" ftype="u32" />
    </msgdef>
  
    <!-- Fractal -->
    <msgdef msgid="Fractal">
      <fielddef fname="Self" ftype="struct">
        <fielddef fname="Point" ftype="s32[]" size="4" />
        <fielddef fname="Self" ftype="struct">
          <fielddef fname="Point" ftype="s32[]" size="4" />
          <fielddef fname="Self" ftype="struct">
            <fielddef fname="Point" ftype="s32[]" size="4" />
          </fielddef>
        </fielddef>
      </fielddef>
      <fielddef fname="Constellation" ftype="Constellation" />
    </msgdef>
  
    <!-- Test Signal -->
    <msgdef msgid="TstSignal">
    </msgdef>
  
    <!-- Test the Universe Command -->
    <msgdef msgid="CmdUniverse">
      <pad />
      <fielddef fname="Truth" ftype="bool" />
      <fielddef fname="Aura" ftype="char" />
      <fielddef fname="Gluon" ftype="u8" />
      <fielddef fname="Electron" ftype="s8" />
      <pad count="3" />
      <fielddef fname="Planet" ftype="u16" />
      <fielddef fname="StellarObj" ftype="s16" />
      <fielddef fname="StarSystem" ftype="u32" />
      <fielddef fname="Galaxy" ftype="s32">
        <min>-99</min>
        <max>9909</max>
       </fielddef>
      <fielddef fname="GalaxyGroup" ftype="u64" />
      <fielddef fname="Filament" ftype="s64" />
      <fielddef fname="Ether" ftype="u32" disposition="deprecated" />
      <fielddef fname="VisUnivLY" ftype="f32" />
      <fielddef fname="FullUnivLY" ftype="f64" />
      <fielddef fname="HiddenDim" ftype="p32" />
      <fielddef fname="ParallelUniv" ftype="p64" />
      <fielddef fname="TheUnamed" ftype="string" size="42" />
      <fielddef fname="Math" ftype="struct">
        <fielddef fname="One" ftype="u16" />
        <fielddef fname="Two" ftype="u32" />
        <fielddef fname="DotDotDot" ftype="u64" />
      </fielddef>
      <fielddef fname="Physics" ftype="uint[]" size="53" />
      <fielddef fname="StarType" ftype="SpectralClass" />
      <fielddef fname="StarInfo" ftype="Star" />
    </msgdef>
  </msg_types>
</netmsgs>