docs/interface/FreeEMS-DDL.mm

   1 <map version="0.8.1">
   2 <!-- To view this file, download free mind mapping software FreeMind from http://freemind.sourceforge.net -->
   3 <node CREATED="1295054950694" ID="Freemind_Link_97820589" MODIFIED="1295054961611" TEXT="FreeEMS-DDL">
   4 <node CREATED="1295054963648" FOLDED="true" ID="_" MODIFIED="1295054968651" POSITION="right" TEXT="Structures">
   5 <node CREATED="1295055085534" ID="Freemind_Link_1932887062" MODIFIED="1295055089962" TEXT="Structure">
   6 <node CREATED="1295055090886" ID="Freemind_Link_581348170" MODIFIED="1295055490047" TEXT="Name">
   7 <node CREATED="1295056876737" ID="Freemind_Link_728383192" MODIFIED="1295056913329" TEXT="camelCaseValidCIdentifier"/>
   8 </node>
   9 <node CREATED="1295055106270" ID="Freemind_Link_780753375" MODIFIED="1295055520035" TEXT="Description">
  10 <node CREATED="1295055794728" ID="Freemind_Link_1038674060" MODIFIED="1295055802339" TEXT="Arbitrary String"/>
  11 </node>
  12 <node CREATED="1295055279435" ID="Freemind_Link_51327626" MODIFIED="1295070409703" TEXT="Members">
  13 <node CREATED="1295055286675" ID="Freemind_Link_487956991" MODIFIED="1295072005007" TEXT="Member" VSHIFT="7">
  14 <node CREATED="1295072058062" HGAP="24" ID="Freemind_Link_518469867" MODIFIED="1295076929801" TEXT="Name" VSHIFT="38">
  15 <node CREATED="1295056876737" ID="Freemind_Link_369954331" MODIFIED="1295056913329" TEXT="camelCaseValidCIdentifier"/>
  16 </node>
  17 <node CREATED="1295126317820" ID="Freemind_Link_1237581391" MODIFIED="1295126321167" TEXT="Description">
  18 <node CREATED="1295055794728" ID="Freemind_Link_1891604257" MODIFIED="1295055802339" TEXT="Arbitrary String"/>
  19 </node>
  20 <node CREATED="1295055290075" ID="Freemind_Link_289504752" MODIFIED="1295055309260" TEXT="Type">
  21 <node CREATED="1295055724438" ID="Freemind_Link_990168552" MODIFIED="1295070774118" TEXT="Embedded Structure">
  22 <node CREATED="1295073426976" ID="Freemind_Link_902584035" MODIFIED="1295076890378" TEXT="reference to name of struct described in this file"/>
  23 </node>
  24 <node CREATED="1295060449354" ID="Freemind_Link_462012820" MODIFIED="1295060453924" TEXT="string">
  25 <node CREATED="1295072112595" ID="Freemind_Link_1608348891" MODIFIED="1295072132179" TEXT="initialise with string with implicit null byte termination"/>
  26 <node CREATED="1295072132823" ID="Freemind_Link_476965414" MODIFIED="1295072145059" TEXT="or maybe with hex bytes and &apos;&apos; chars comma seperated"/>
  27 <node CREATED="1295072145759" ID="Freemind_Link_1815957938" MODIFIED="1295072156250" TEXT="need different mech for this or not? review C..."/>
  28 </node>
  29 <node CREATED="1295055739357" ID="Freemind_Link_1148409383" MODIFIED="1295055740792" TEXT="array">
  30 <node CREATED="1295073392203" ID="Freemind_Link_1453994828" MODIFIED="1295073405645" TEXT="primitive type"/>
  31 <node CREATED="1295126376768" ID="Freemind_Link_1511633365" MODIFIED="1295126382843" TEXT="should allow complex types?"/>
  32 <node CREATED="1295073406225" ID="Freemind_Link_1761752028" MODIFIED="1295073416892" TEXT="size/length/count"/>
  33 </node>
  34 <node CREATED="1295070727013" ID="Freemind_Link_1607189331" MODIFIED="1295070729257" TEXT="primitives">
  35 <node CREATED="1295055741396" ID="Freemind_Link_175573994" MODIFIED="1295057159254" TEXT="int8"/>
  36 <node CREATED="1295057160051" ID="Freemind_Link_965411911" MODIFIED="1295057161782" TEXT="int16"/>
  37 <node CREATED="1295057165098" ID="Freemind_Link_974482838" MODIFIED="1295057167365" TEXT="int32"/>
  38 <node CREATED="1295057167690" ID="Freemind_Link_1895351719" MODIFIED="1295057169733" TEXT="int64"/>
  39 <node CREATED="1295057170042" ID="Freemind_Link_212300535" MODIFIED="1295057177189" TEXT="uint8"/>
  40 <node CREATED="1295057178297" ID="Freemind_Link_1210849335" MODIFIED="1295057181148" TEXT="uint16"/>
  41 <node CREATED="1295057181473" ID="Freemind_Link_869639131" MODIFIED="1295057185852" TEXT="uint32"/>
  42 <node CREATED="1295057186392" ID="Freemind_Link_188479725" MODIFIED="1295057194539" TEXT="uint64"/>
  43 <node CREATED="1295057195144" ID="Freemind_Link_1955232050" MODIFIED="1295057201187" TEXT="float32"/>
  44 <node CREATED="1295057201567" ID="Freemind_Link_192533444" MODIFIED="1295057206354" TEXT="double64"/>
  45 </node>
  46 <node CREATED="1295072521411" ID="Freemind_Link_546636645" MODIFIED="1295072526973" TEXT="bitfield groups">
  47 <node CREATED="1295072527563" ID="Freemind_Link_135956286" MODIFIED="1295314101638" TEXT="Container">
  48 <node CREATED="1295314102395" ID="Freemind_Link_901141846" MODIFIED="1295314108279" TEXT="uint8"/>
  49 <node CREATED="1295314108587" ID="Freemind_Link_1022863056" MODIFIED="1295314111391" TEXT="uint16"/>
  50 <node CREATED="1295314111652" ID="Freemind_Link_1120728192" MODIFIED="1295314114591" TEXT="uint32"/>
  51 <node CREATED="1295314115571" ID="Freemind_Link_1684037317" MODIFIED="1295314119256" TEXT="uint64"/>
  52 </node>
  53 <node CREATED="1295075321837" ID="Freemind_Link_1693219897" MODIFIED="1295314162019" TEXT="Bit fields">
  54 <node CREATED="1295075356762" ID="Freemind_Link_1748356336" MODIFIED="1295314173613" TEXT="Bit field">
  55 <node CREATED="1295075358955" ID="Freemind_Link_1742557028" MODIFIED="1295075360654" TEXT="Name">
  56 <node CREATED="1295056876737" ID="Freemind_Link_72847294" MODIFIED="1295056913329" TEXT="camelCaseValidCIdentifier"/>
  57 </node>
  58 <node CREATED="1295314181458" ID="Freemind_Link_1150839591" MODIFIED="1295314685203" TEXT="Width">
  59 <node CREATED="1295314207397" ID="Freemind_Link_773244414" MODIFIED="1295314236460" TEXT="Positive integer less than the length of the container size"/>
  60 </node>
  61 <node CREATED="1295075361114" ID="Freemind_Link_1198407438" MODIFIED="1295075365396" TEXT="Description">
  62 <node CREATED="1295055794728" ID="Freemind_Link_428835922" MODIFIED="1295055802339" TEXT="Arbitrary String"/>
  63 </node>
  64 </node>
  65 </node>
  66 </node>
  67 </node>
  68 </node>
  69 </node>
  70 </node>
  71 </node>
  72 <node CREATED="1295054969191" FOLDED="true" HGAP="29" ID="Freemind_Link_1308391612" MODIFIED="1295058685923" POSITION="right" TEXT="Instances" VSHIFT="-18">
  73 <node CREATED="1295056060883" ID="Freemind_Link_1566182298" MODIFIED="1295056064158" TEXT="Instance">
  74 <node CREATED="1295055426439" ID="Freemind_Link_1638933398" MODIFIED="1295055460920" TEXT="Location ID">
  75 <node CREATED="1295055761315" ID="Freemind_Link_1723951298" MODIFIED="1295055773405" TEXT="0 - 65535/0 - 0xFFFF"/>
  76 </node>
  77 <node CREATED="1295055090886" ID="Freemind_Link_1568705440" MODIFIED="1295055490047" TEXT="Name">
  78 <node CREATED="1295056876737" ID="Freemind_Link_1039327800" MODIFIED="1295056913329" TEXT="camelCaseValidCIdentifier"/>
  79 </node>
  80 <node CREATED="1295055106270" ID="Freemind_Link_873708223" MODIFIED="1295055520035" TEXT="Description">
  81 <node CREATED="1295055794728" ID="Freemind_Link_467648927" MODIFIED="1295055802339" TEXT="Arbitrary String"/>
  82 </node>
  83 <node CREATED="1295092079030" ID="Freemind_Link_748424588" MODIFIED="1295126580223" TEXT="Type">
  84 <node CREATED="1295073426976" ID="Freemind_Link_1714251361" MODIFIED="1295076890378" TEXT="reference to name of struct described in this file"/>
  85 </node>
  86 <node CREATED="1295127620509" ID="Freemind_Link_1878726924" MODIFIED="1295127634006" TEXT="RequiresInitialisation">
  87 <node CREATED="1295127634316" ID="Freemind_Link_1335073101" MODIFIED="1295127635903" TEXT="true">
  88 <node CREATED="1295128075072" ID="Freemind_Link_636843431" MODIFIED="1295128085219" TEXT="used for settings"/>
  89 <node CREATED="1295128255677" ID="Freemind_Link_633467946" MODIFIED="1295128270544" TEXT="metadata required"/>
  90 <node CREATED="1295127641027" ID="Freemind_Link_864152975" MODIFIED="1295127957747" TEXT="pre/post modifiers are optional"/>
  91 <node CREATED="1295127641027" ID="Freemind_Link_423652072" MODIFIED="1295127966810" TEXT="init data must be present below"/>
  92 </node>
  93 <node CREATED="1295127636524" ID="Freemind_Link_1002686172" MODIFIED="1295127637615" TEXT="false">
  94 <node CREATED="1295128090087" ID="Freemind_Link_98460536" MODIFIED="1295128101937" TEXT="used for dynamic variables"/>
  95 <node CREATED="1295127885892" ID="Freemind_Link_1531600669" MODIFIED="1295127899470" TEXT="metadata still required"/>
  96 <node CREATED="1295127900098" ID="Freemind_Link_1848175859" MODIFIED="1295127907070" TEXT="init data not required"/>
  97 <node CREATED="1295127865621" ID="Freemind_Link_400967570" MODIFIED="1295127885463" TEXT="pre/post mods are ignored"/>
  98 </node>
  99 </node>
 100 <node CREATED="1295071896737" ID="Freemind_Link_412867311" MODIFIED="1295314521493" TEXT="Qualifiers">
 101 <node CREATED="1295092312537" ID="Freemind_Link_1580969995" MODIFIED="1295092317165" TEXT="const"/>
 102 <node CREATED="1295092317568" ID="Freemind_Link_1858407024" MODIFIED="1295092320109" TEXT="volatile"/>
 103 </node>
 104 <node CREATED="1295071905969" ID="Freemind_Link_876166804" MODIFIED="1295314533237" TEXT="Attributes">
 105 <node CREATED="1295092324576" ID="Freemind_Link_1952086712" MODIFIED="1295314540887" TEXT="memory macros etc"/>
 106 </node>
 107 <node CREATED="1295071914832" ID="Freemind_Link_1350158791" MODIFIED="1295071932498" TEXT="Initialisers">
 108 <node CREATED="1295071933879" ID="Freemind_Link_1249899787" MODIFIED="1295071939978" TEXT="Initialiser">
 109 <node CREATED="1295071940502" ID="Freemind_Link_1164605336" MODIFIED="1295071974655" TEXT="String Data in the matching format for the type in the referenced structure, GCC will catch mistakes."/>
 110 <node CREATED="1295126690979" ID="Freemind_Link_63560959" MODIFIED="1295126711070" TEXT="Nested where nested structs exist in type"/>
 111 <node CREATED="1295128197625" ID="Freemind_Link_556508501" MODIFIED="1295128204797" TEXT="Need metadata here too, how to structure?">
 112 <node CREATED="1295126799116" ID="Freemind_Link_526931198" MODIFIED="1295128232938" TEXT="conversion info">
 113 <node CREATED="1295128170985" ID="Freemind_Link_525017322" MODIFIED="1295128175798" TEXT="internal unit"/>
 114 <node CREATED="1295127088626" ID="Freemind_Link_1132611618" MODIFIED="1295127093501" TEXT="offset"/>
 115 <node CREATED="1295127093897" ID="Freemind_Link_90178106" MODIFIED="1295127096805" TEXT="multiplier"/>
 116 </node>
 117 <node CREATED="1295126827411" ID="Freemind_Link_793636607" MODIFIED="1295126882219" TEXT="Need normal/extreme/limit values for top and bottom">
 118 <node CREATED="1295127676176" ID="Freemind_Link_992302813" MODIFIED="1295128140928" TEXT="use as guides for settings?"/>
 119 <node CREATED="1295127729334" ID="Freemind_Link_1742794459" MODIFIED="1295128126224" TEXT="use for display of dynamic vars "/>
 120 </node>
 121 <node CREATED="1295130388911" ID="Freemind_Link_225156899" MODIFIED="1295130401729" TEXT="Display Name">
 122 <node CREATED="1295130402870" ID="Freemind_Link_1451489942" MODIFIED="1295130409633" TEXT="Arbitrary String"/>
 123 </node>
 124 </node>
 125 <node CREATED="1295126883223" ID="Freemind_Link_1980835143" MODIFIED="1295127215253" TEXT="how to handle OAOO of #define stuff and #include stuff such as included table data and axis sizes etc"/>
 126 </node>
 127 </node>
 128 </node>
 129 </node>
 130 <node CREATED="1295314001182" FOLDED="true" ID="Freemind_Link_1526657595" MODIFIED="1295314013093" POSITION="left" TEXT="Version">
 131 <node CREATED="1295314027964" ID="Freemind_Link_454209988" MODIFIED="1295314036832" TEXT="Arbitrary String"/>
 132 </node>
 133 <node CREATED="1295054978592" FOLDED="true" ID="Freemind_Link_1047542891" MODIFIED="1295054986947" POSITION="left" TEXT="Interface Version">
 134 <node CREATED="1295060094652" ID="Freemind_Link_162999746" MODIFIED="1295060105295" TEXT="Undefined format, possibly just a string, parsed in a certain way."/>
 135 <node CREATED="1295060122082" ID="Freemind_Link_202044789" MODIFIED="1295060193752" TEXT="The version upgrade path semantics on this possibly no longer matter with the data description service stuff"/>
 136 </node>
 137 <node CREATED="1295055940316" FOLDED="true" ID="Freemind_Link_1252171363" MODIFIED="1295055943095" POSITION="left" TEXT="Notes">
 138 <node CREATED="1295055944244" ID="Freemind_Link_1770492473" MODIFIED="1295055946033" TEXT="Note">
 139 <node CREATED="1295055963203" ID="Freemind_Link_1653509447" MODIFIED="1295055967206" TEXT="Title">
 140 <node CREATED="1295055987320" ID="Freemind_Link_560570732" MODIFIED="1295055991732" TEXT="Arbitrary String"/>
 141 </node>
 142 <node CREATED="1295055977922" ID="Freemind_Link_1547490228" MODIFIED="1295055981476" TEXT="Content">
 143 <node CREATED="1295055946508" ID="Freemind_Link_682652048" MODIFIED="1295055954191" TEXT="Arbitrary String"/>
 144 </node>
 145 </node>
 146 </node>
 147 <node CREATED="1295055883569" FOLDED="true" ID="Freemind_Link_314948960" MODIFIED="1295058348458" POSITION="left" TEXT="PayloadIDs">
 148 <node CREATED="1295055918950" ID="Freemind_Link_479458067" MODIFIED="1295058363689" TEXT="PayloadID">
 149 <node CREATED="1295056583617" ID="Freemind_Link_1005995527" MODIFIED="1295058377056" TEXT="ID">
 150 <node CREATED="1295056593960" ID="Freemind_Link_921919665" MODIFIED="1295056609578" TEXT="0 - 65535/0 - 0xFFFF"/>
 151 </node>
 152 <node CREATED="1295056091664" ID="Freemind_Link_1935699995" MODIFIED="1295060548302" TEXT="Name">
 153 <node CREATED="1295056876737" ID="Freemind_Link_1927447471" MODIFIED="1295056913329" TEXT="camelCaseValidCIdentifier"/>
 154 </node>
 155 <node CREATED="1295060548826" ID="Freemind_Link_176272650" MODIFIED="1295060550814" TEXT="Status">
 156 <node CREATED="1295060552010" ID="Freemind_Link_1302204832" MODIFIED="1295060566852" TEXT="Current">
 157 <node CREATED="1295060571289" ID="Freemind_Link_434851495" MODIFIED="1295060578884" TEXT="Should be used for new and existing designs"/>
 158 </node>
 159 <node CREATED="1295060567201" ID="Freemind_Link_389509129" MODIFIED="1295060569388" TEXT="Deprecated">
 160 <node CREATED="1295060580567" ID="Freemind_Link_1663226101" MODIFIED="1295060588579" TEXT="Should NOT be used for new designs"/>
 161 <node CREATED="1295060588984" ID="Freemind_Link_1005448757" MODIFIED="1295060618305" TEXT="Should be phased out from existing designs"/>
 162 </node>
 163 <node CREATED="1295060633404" ID="Freemind_Link_1890847315" MODIFIED="1295060637111" TEXT="TestOnly">
 164 <node CREATED="1295060649338" ID="Freemind_Link_1548183532" MODIFIED="1295060687099" TEXT="Not to be used, except for testing"/>
 165 <node CREATED="1295060687584" ID="Freemind_Link_1575687360" MODIFIED="1295060694090" TEXT="May be removed without warning at any time"/>
 166 </node>
 167 </node>
 168 <node CREATED="1295056502639" ID="Freemind_Link_1631680006" MODIFIED="1295056505738" TEXT="Description">
 169 <node CREATED="1295058551368" ID="Freemind_Link_956747082" MODIFIED="1295058558554" TEXT="Arbitrary String"/>
 170 </node>
 171 <node CREATED="1295058698038" ID="Freemind_Link_492834460" MODIFIED="1295058710359" TEXT="ContentID">
 172 <node CREATED="1295058712069" ID="Freemind_Link_1663798519" MODIFIED="1295058735534" TEXT="no idea how to do this, possibly link to an instance or structure"/>
 173 </node>
 174 <node CREATED="1295060960852" ID="Freemind_Link_1317718050" MODIFIED="1295060966576" TEXT="HasContent?">
 175 <node CREATED="1295060967084" ID="Freemind_Link_1593582893" MODIFIED="1295126095149" TEXT="how to describe packets with/without arguments, with/without data"/>
 176 </node>
 177 <node CREATED="1295060378647" ID="Freemind_Link_556998624" MODIFIED="1295060382978" TEXT="Length">
 178 <node CREATED="1295060755978" ID="Freemind_Link_1193360840" MODIFIED="1295060776018" TEXT="Not including header or checksum"/>
 179 <node CREATED="1295060799968" ID="Freemind_Link_708407923" MODIFIED="1295060818017" TEXT="A positive integer"/>
 180 <node CREATED="1295060825021" ID="Freemind_Link_1047368061" MODIFIED="1295060828769" TEXT="Can be variable"/>
 181 </node>
 182 <node CREATED="1295060845580" ID="Freemind_Link_989435751" MODIFIED="1295060849079" TEXT="MinLength">
 183 <node CREATED="1295060895281" ID="Freemind_Link_214507019" MODIFIED="1295060907891" TEXT="maybe just this instead"/>
 184 </node>
 185 <node CREATED="1295060849507" ID="Freemind_Link_892000692" MODIFIED="1295060851847" TEXT="MaxLength"/>
 186 <node CREATED="1295060909078" ID="Freemind_Link_1232181307" MODIFIED="1295060915218" TEXT="LengthWithoutData">
 187 <node CREATED="1295060917487" ID="Freemind_Link_573167457" MODIFIED="1295060921210" TEXT="maybe this is the best format"/>
 188 </node>
 189 <node CREATED="1295060383599" ID="Freemind_Link_1739355357" MODIFIED="1295060396513" TEXT="Content? use ID above?"/>
 190 </node>
 191 </node>
 192 <node CREATED="1295061087436" FOLDED="true" ID="Freemind_Link_246400430" MODIFIED="1295061090431" POSITION="left" TEXT="ErrorIDs">
 193 <node CREATED="1295061091436" ID="Freemind_Link_890707077" MODIFIED="1295061094374" TEXT="ErrorID">
 194 <node CREATED="1295061097396" ID="Freemind_Link_803103528" MODIFIED="1295061098583" TEXT="ID">
 195 <node CREATED="1295056593960" ID="Freemind_Link_1965808330" MODIFIED="1295056609578" TEXT="0 - 65535/0 - 0xFFFF"/>
 196 </node>
 197 <node CREATED="1295061099043" ID="Freemind_Link_707084184" MODIFIED="1295061105958" TEXT="Name">
 198 <node CREATED="1295056876737" ID="Freemind_Link_706141046" MODIFIED="1295056913329" TEXT="camelCaseValidCIdentifier"/>
 199 </node>
 200 <node CREATED="1295061106419" ID="Freemind_Link_199138221" MODIFIED="1295061110221" TEXT="Description">
 201 <node CREATED="1295058551368" ID="Freemind_Link_113398013" MODIFIED="1295058558554" TEXT="Arbitrary String"/>
 202 </node>
 203 </node>
 204 </node>
 205 </node>
 206 </map>