Teledyne LeCroy FireInspector - File Based Decoding - Manual (Page 63)

57
CATC S CRIPTING L ANGUAGE 1.0 C HAPTER 14
Reference Manual FireInspector-Specific Primitives
C
HAPTER
14: F
IRE
I
NSPECTOR
-
S
PECIFIC
P
RIMITIVES
BitfieldInit()
BitfieldInit(string>,
string</i>>)</p><p style="position:absolute;top:497px;left:168px;white-space:nowrap" class="ft09"><i>Return value</i></p><p style="position:absolute;top:523px;left:168px;white-space:nowrap" class="ft010">None.</p><p style="position:absolute;top:556px;left:168px;white-space:nowrap" class="ft09"><i>Comments</i></p><p style="position:absolute;top:584px;left:168px;white-space:nowrap" class="ft07">BitfieldInit</p><p style="position:absolute;top:582px;left:303px;white-space:nowrap" class="ft010"> initializes the data structure for keeping field information. This </p><p style="position:absolute;top:604px;left:168px;white-space:nowrap" class="ft016">field information can be presented to the user in the form of a dialog box (see <br><a rel="nofollow" href="?page=64">“</a></p><p style="position:absolute;top:627px;left:177px;white-space:nowrap" class="ft07"><a rel="nofollow" href="?page=64">BitfieldDialog()</a></p><p style="position:absolute;top:626px;left:356px;white-space:nowrap" class="ft010"><a rel="nofollow" href="?page=64">” on page 58). The pr</a>imitives </p><p style="position:absolute;top:627px;left:581px;white-space:nowrap" class="ft07">GetNBits</p><p style="position:absolute;top:626px;left:671px;white-space:nowrap" class="ft010"> and </p><p style="position:absolute;top:649px;left:168px;white-space:nowrap" class="ft07">NextNBits</p><p style="position:absolute;top:648px;left:269px;white-space:nowrap" class="ft010"> both support optional arguments for appending information to this </p><p style="position:absolute;top:670px;left:168px;white-space:nowrap" class="ft010">data stucture (see<a rel="nofollow" href="?page=63"> “</a></p><p style="position:absolute;top:671px;left:311px;white-space:nowrap" class="ft07"><a rel="nofollow" href="?page=63">GetNBits</a></p><p style="position:absolute;top:670px;left:401px;white-space:nowrap" class="ft010"><a rel="nofollow" href="?page=63"> -- Additional parameters” on page 57 a</a>nd </p><p style="position:absolute;top:692px;left:168px;white-space:nowrap" class="ft010"><a rel="nofollow" href="?page=64">“</a></p><p style="position:absolute;top:693px;left:177px;white-space:nowrap" class="ft07"><a rel="nofollow" href="?page=64">NextNBits</a></p><p style="position:absolute;top:692px;left:278px;white-space:nowrap" class="ft010"><a rel="nofollow" href="?page=64"> -- Additional parameters” on page 58)</a>.</p><p style="position:absolute;top:724px;left:168px;white-space:nowrap" class="ft09"><i>Example</i></p><p style="position:absolute;top:751px;left:168px;white-space:nowrap" class="ft010">Se<a rel="nofollow" href="?page=66">e “Example for FireInspector-Specific Primitives” on page 60.</a></p><p style="position:absolute;top:802px;left:168px;white-space:nowrap" class="ft06"><b>GetNBits</b></p><p style="position:absolute;top:800px;left:303px;white-space:nowrap" class="ft011"><b> -- Additional parameters</b></p><p style="position:absolute;top:846px;left:168px;white-space:nowrap" class="ft07">GetNBits</p><p style="position:absolute;top:844px;left:258px;white-space:nowrap" class="ft010"> contains two additional, optional arguments in FireInspector to add </p><p style="position:absolute;top:866px;left:168px;white-space:nowrap" class="ft010">data to the </p><p style="position:absolute;top:867px;left:251px;white-space:nowrap" class="ft07">BitfieldInit</p><p style="position:absolute;top:866px;left:386px;white-space:nowrap" class="ft010"> data structure: </p><p style="position:absolute;top:867px;left:501px;white-space:nowrap" class="ft07">bitfield_identifier</p><p style="position:absolute;top:866px;left:714px;white-space:nowrap" class="ft010"> and </p><p style="position:absolute;top:889px;left:168px;white-space:nowrap" class="ft07">bitfield_label</p><p style="position:absolute;top:888px;left:325px;white-space:nowrap" class="ft010">. In FireInspector, </p><p style="position:absolute;top:889px;left:463px;white-space:nowrap" class="ft07">GetNBits</p><p style="position:absolute;top:888px;left:553px;white-space:nowrap" class="ft010"> has this structure:</p><p style="position:absolute;top:922px;left:196px;white-space:nowrap" class="ft015">GetNBits(<bit_source <i>list</i> or <i>raw</i>>, <bit_offset <br><i>integer</i>>, <bit_count <i>integer</i>>, <bitfield_identifier <br><i>string</i>></p><p style="position:absolute;top:973px;left:275px;white-space:nowrap" class="ft012"><i>opt</i></p><p style="position:absolute;top:966px;left:302px;white-space:nowrap" class="ft07">, <bitfield_label <i>string</i>></p><p style="position:absolute;top:973px;left:582px;white-space:nowrap" class="ft012"><i>opt</i></p><p style="position:absolute;top:966px;left:609px;white-space:nowrap" class="ft07">)</p><p style="position:absolute;top:999px;left:168px;white-space:nowrap" class="ft010">Use </p><p style="position:absolute;top:1000px;left:202px;white-space:nowrap" class="ft07">bitfield_identifier</p><p style="position:absolute;top:999px;left:415px;white-space:nowrap" class="ft010"> to refer to a bitfield data structure that has been </p><p style="position:absolute;top:1020px;left:168px;white-space:nowrap" class="ft010">named in a </p><p style="position:absolute;top:1022px;left:255px;white-space:nowrap" class="ft07">BitfieldInit</p><p style="position:absolute;top:1020px;left:390px;white-space:nowrap" class="ft010"> declaration. Use </p><p style="position:absolute;top:1022px;left:521px;white-space:nowrap" class="ft07">bitfield_label</p><p style="position:absolute;top:1020px;left:678px;white-space:nowrap" class="ft010"> to assign a </p><p style="position:absolute;top:1042px;left:168px;white-space:nowrap" class="ft010">label to the group of bits being read. For example:</p><p style="position:absolute;top:1076px;left:196px;white-space:nowrap" class="ft07">GetNBits( data, 0, 1, "Identifier", "Label" );</p><p style="position:absolute;top:368px;left:215px;white-space:nowrap" class="ft013"><b>Parameter</b></p><p style="position:absolute;top:368px;left:343px;white-space:nowrap" class="ft013"><b>Meaning</b></p><p style="position:absolute;top:368px;left:418px;white-space:nowrap" class="ft013"><b>Default Value</b></p><p style="position:absolute;top:368px;left:612px;white-space:nowrap" class="ft013"><b>Comments</b></p><p style="position:absolute;top:394px;left:179px;white-space:nowrap" class="ft00">bitfield_identifier <i>string</i></p><p style="position:absolute;top:394px;left:334px;white-space:nowrap" class="ft00">The name of </p><p style="position:absolute;top:411px;left:339px;white-space:nowrap" class="ft00">the bitfield </p><p style="position:absolute;top:428px;left:332px;white-space:nowrap" class="ft00">data structure</p><p style="position:absolute;top:394px;left:507px;white-space:nowrap" class="ft017">Used to refer to this bitfield data structure in sub-<br>sequent calls to other primitives.</p><p style="position:absolute;top:455px;left:218px;white-space:nowrap" class="ft00">title <i>string</i></p><p style="position:absolute;top:455px;left:507px;white-space:nowrap" class="ft00">Displays in the title bar of the dialog box.</p></div> </div> <div class="manual-page-original" itemscope="itemscope" itemtype="https://schema.org/ImageObject" data-img="/screens/366114/63.png" style="display: none;"> </div> </div> <a href="/manuals/353543/teledyne-lecroy-fireinspector-file-based-decoding.html?page=62" class="manual-view__prev -onpage-nav" title="Previous (← + Ctrl)" aria-label="Previous page"><svg class="svg-icon"><use xlink:href="#icon-arrow-6"></use></svg></a> <a href="/manuals/353543/teledyne-lecroy-fireinspector-file-based-decoding.html?page=64" class="manual-view__next -onpage-nav" title="Next (Ctrl + →)" aria-label="Next page"><svg class="svg-icon"><use xlink:href="#icon-arrow-6"></use></svg></a> </div> </div> <nav class="inline-nav inline-nav--dark-grey inline-nav--bottom"> <div class="pager pager--left" id="def-pager"> <span class="pager__label">Pages:</span> <a class="pager__a pager__prev" aria-label="Previous page" href="/manuals/353543/teledyne-lecroy-fireinspector-file-based-decoding.html?page=62"><svg class="svg-icon"><use xlink:href="#icon-arrow-2"></use></svg></a> <a class="pager__a pager__number" href="/manuals/353543/teledyne-lecroy-fireinspector-file-based-decoding.html">1</a> <span class="pager__hellip">…</span> <a class="pager__a pager__number" href="/manuals/353543/teledyne-lecroy-fireinspector-file-based-decoding.html?page=61">61</a> <a class="pager__a pager__number" href="/manuals/353543/teledyne-lecroy-fireinspector-file-based-decoding.html?page=62">62</a> <span class="pager__a pager__number active">63</span> <a class="pager__a pager__number" href="/manuals/353543/teledyne-lecroy-fireinspector-file-based-decoding.html?page=64">64</a> <a class="pager__a pager__number" href="/manuals/353543/teledyne-lecroy-fireinspector-file-based-decoding.html?page=65">65</a> <span class="pager__hellip">…</span> <a class="pager__a pager__number" href="/manuals/353543/teledyne-lecroy-fireinspector-file-based-decoding.html?page=74">74</a> <a class="pager__a pager__next" aria-label="Next page" href="/manuals/353543/teledyne-lecroy-fireinspector-file-based-decoding.html?page=64"><svg class="svg-icon"><use xlink:href="#icon-arrow-3"></use></svg></a> </div> <div class="complain"> <div class="popup-menu complain__menu" id="complain-wnd" style="display: none;"> <ul> <li><a href="javascript:" class="ajax-link" data-type="brand">wrong Brand</a></li> <li><a href="javascript:" class="ajax-link" data-type="model">wrong Model</a></li> <li><a href="javascript:" class="ajax-link" data-type="readability">non readable</a></li> </ul> </div> </div> </nav> </div> </div> </div> <div class="manual-related-docs"> <span class="title title--h2">See also other documents in the category Teledyne LeCroy Equipment:</span> <div class="manual-also-for__list"> <ul class="list-block__list"> <li> <a href="/manuals/353414/teledyne-lecroy-6zi-rackmount.html"> <span class="model-name">6Zi Rackmount</span> <span class="pages">(12 pages)</span> </a> </li> <li> <a href="/manuals/353415/teledyne-lecroy-hdo-oscilloscope-rackmount.html"> <span class="model-name">HDO Oscilloscope Rackmount</span> <span class="pages">(14 pages)</span> </a> </li> <li> <a href="/manuals/353426/teledyne-lecroy-lsib-1-host-interfaces.html"> <span class="model-name">LSIB-1 Host Interfaces</span> <span class="pages">(44 pages)</span> </a> </li> <li> <a href="/manuals/353416/teledyne-lecroy-oc1021-oscilloscope-cart.html"> <span class="model-name">OC1021 Oscilloscope Cart</span> <span class="pages">(9 pages)</span> </a> </li> <li> <a href="/manuals/353420/teledyne-lecroy-oc1024-oscilloscope-cart.html"> <span class="model-name">OC1024 Oscilloscope Cart</span> <span class="pages">(10 pages)</span> </a> </li> <li> <a href="/manuals/353419/teledyne-lecroy-oc910-oscilloscope-cart.html"> <span class="model-name">OC910 Oscilloscope Cart</span> <span class="pages">(2 pages)</span> </a> </li> <li> <a href="/manuals/353417/teledyne-lecroy-ttl-aux-out.html"> <span class="model-name">TTL-AUX-OUT</span> <span class="pages">(1 page)</span> </a> </li> <li> <a href="/manuals/353418/teledyne-lecroy-wavejet-rackmount.html"> <span class="model-name">WaveJet Rackmount</span> <span class="pages">(1 page)</span> </a> </li> <li> <a href="/manuals/353422/teledyne-lecroy-zi-oscilloscope-rackmount.html"> <span class="model-name">Zi Oscilloscope Rackmount</span> <span class="pages">(12 pages)</span> </a> </li> <li> <a href="/manuals/353423/teledyne-lecroy-usb2-gpib.html"> <span class="model-name">USB2-GPIB</span> <span class="pages">(12 pages)</span> </a> </li> <li> <a href="/manuals/353421/teledyne-lecroy-wm8zi-2x80gs.html"> <span class="model-name">WM8Zi-2X80GS</span> <span class="pages">(2 pages)</span> </a> </li> <li> <a href="/manuals/353424/teledyne-lecroy-waverunner-6-zi_hro-6-zi-8-channel-sync-instruction-manual-wr6zi-8ch-synch.html"> <span class="model-name">WR6ZI-8CH-SYNCH</span> <span class="pages">(6 pages)</span> </a> </li> <li> <a href="/manuals/353425/teledyne-lecroy-zi-oscilloscope-synchronization-probus-module-zi-8ch-synch.html"> <span class="model-name">Zi Oscilloscope Synchronization ProBus Module (Zi-8CH-SYNCH)</span> <span class="pages">(16 pages)</span> </a> </li> <li> <a href="/manuals/353427/teledyne-lecroy-logicstudio.html"> <span class="model-name">LogicStudio</span> <span class="pages">(42 pages)</span> </a> </li> <li> <a href="/manuals/353431/teledyne-lecroy-wavesurfer-mxs-b-getting-started-manual.html"> <span class="model-name">WaveSurfer MXs-B Getting Started Manual</span> <span class="pages">(126 pages)</span> </a> </li> <li> <a href="/manuals/353428/teledyne-lecroy-wavesurfer-mxs-b-quick-reference-guide.html"> <span class="model-name">WaveSurfer MXs-B Quick Reference Guide</span> <span class="pages">(16 pages)</span> </a> </li> <li> <a href="/manuals/353435/teledyne-lecroy-x-stream-oscilloscopes-remote-control.html"> <span class="model-name">X-STREAM OSCILLOSCOPES Remote Control</span> <span class="pages">(305 pages)</span> </a> </li> <li> <a href="/manuals/353429/teledyne-lecroy-ws-gpib.html"> <span class="model-name">WS-GPIB</span> <span class="pages">(12 pages)</span> </a> </li> <li> <a href="/manuals/353436/teledyne-lecroy-pxa125.html"> <span class="model-name">PXA125</span> <span class="pages">(219 pages)</span> </a> </li> <li> <a href="/manuals/353430/teledyne-lecroy-pxd-series.html"> <span class="model-name">PXD Series</span> <span class="pages">(42 pages)</span> </a> </li> <li> <a href="/manuals/353433/teledyne-lecroy-pxd222.html"> <span class="model-name">PXD222</span> <span class="pages">(38 pages)</span> </a> </li> <li> <a href="/manuals/353432/teledyne-lecroy-oscilloscope-system-recovery.html"> <span class="model-name">Oscilloscope System Recovery</span> <span class="pages">(8 pages)</span> </a> </li> <li> <a href="/manuals/353442/teledyne-lecroy-labmaster-9zi-a.html"> <span class="model-name">LabMaster 9Zi-A</span> <span class="pages">(264 pages)</span> </a> </li> <li> <a href="/manuals/353434/teledyne-lecroy-labmaster-10zi-rackmount.html"> <span class="model-name">LabMaster 10Zi Rackmount</span> <span class="pages">(8 pages)</span> </a> </li> <li> <a href="/manuals/353441/teledyne-lecroy-labmaster-10zi-getting-started-manual.html"> <span class="model-name">LabMaster 10Zi Getting Started Manual</span> <span class="pages">(236 pages)</span> </a> </li> <li> <a href="/manuals/353439/teledyne-lecroy-labmaster-10zi-operators-manual.html"> <span class="model-name">LabMaster 10Zi Operators Manual</span> <span class="pages">(198 pages)</span> </a> </li> <li> <a href="/manuals/353437/teledyne-lecroy-waveace-1000_2000.html"> <span class="model-name">WaveAce 1000_2000</span> <span class="pages">(108 pages)</span> </a> </li> <li> <a href="/manuals/353438/teledyne-lecroy-waveace-1000_2000-remote-control.html"> <span class="model-name">WaveAce 1000_2000 Remote Control</span> <span class="pages">(92 pages)</span> </a> </li> <li> <a href="/manuals/353440/teledyne-lecroy-waverunner-mxi-a-quick-reference-guide-waverunner-xi-a-quick-reference-guide.html"> <span class="model-name">WaveRunner Xi-A Quick Reference Guide</span> <span class="pages">(16 pages)</span> </a> </li> <li> <a href="/manuals/353444/teledyne-lecroy-waverunner-xi-series-operatorsmanual.html"> <span class="model-name">WaveRunner XI SERIES Operator’s Manual</span> <span class="pages">(233 pages)</span> </a> </li> <li> <a href="/manuals/353449/teledyne-lecroy-wavepro-automation-command-wavemaster-automation-command.html"> <span class="model-name">WaveMaster Automation Command</span> <span class="pages">(667 pages)</span> </a> </li> <li> <a href="/manuals/353445/teledyne-lecroy-wavemaster-8-zi_zi-a.html"> <span class="model-name">WaveMaster 8 Zi_Zi-A</span> <span class="pages">(190 pages)</span> </a> </li> <li> <a href="/manuals/353443/teledyne-lecroy-wavemaster-8000a.html"> <span class="model-name">WaveMaster 8000A</span> <span class="pages">(46 pages)</span> </a> </li> <li> <a href="/manuals/353448/teledyne-lecroy-wavepro-7-zi_zi-a.html"> <span class="model-name">WavePro 7 Zi_Zi-A</span> <span class="pages">(188 pages)</span> </a> </li> <li> <a href="/manuals/353447/teledyne-lecroy-waveexpert-series-automation-manual.html"> <span class="model-name">WaveExpert series Automation Manual</span> <span class="pages">(285 pages)</span> </a> </li> <li> <a href="/manuals/353446/teledyne-lecroy-waveexpert-9000_nro9000_sda100g-getting-started-manual.html"> <span class="model-name">WaveExpert 9000_NRO9000_SDA100G Getting Started Manual</span> <span class="pages">(50 pages)</span> </a> </li> <li> <a href="/manuals/353451/teledyne-lecroy-waveexpert-100h-operators-manual.html"> <span class="model-name">WaveExpert 100H Operators Manual</span> <span class="pages">(348 pages)</span> </a> </li> <li> <a href="/manuals/353454/teledyne-lecroy-waverunner-automation-command.html"> <span class="model-name">WaveRunner Automation Command</span> <span class="pages">(460 pages)</span> </a> </li> <li> <a href="/manuals/353450/teledyne-lecroy-waverunner-mxi-a-getting-started-manual-waverunner-xi-a-getting-started-manual.html"> <span class="model-name">WaveRunner Xi-A Getting Started Manual</span> <span class="pages">(128 pages)</span> </a> </li> <li> <a href="/manuals/353458/teledyne-lecroy-waverunner-6-zi-and-12-bit-hro-getting-started-manual.html"> <span class="model-name">WaveRunner 6 Zi and 12-Bit HRO Getting Started Manual</span> <span class="pages">(198 pages)</span> </a> </li> <li> <a href="/manuals/353453/teledyne-lecroy-waverunner-6-zi-quick-reference-guide.html"> <span class="model-name">WaveRunner 6 Zi Quick Reference Guide</span> <span class="pages">(20 pages)</span> </a> </li> <li> <a href="/manuals/353452/teledyne-lecroy-waverunner-6-zi-extref-in_out.html"> <span class="model-name">WaveRunner 6 Zi-ExtRef-IN_OUT</span> <span class="pages">(2 pages)</span> </a> </li> <li> <a href="/manuals/353459/teledyne-lecroy-wavesurfer-automation-command.html"> <span class="model-name">WaveSurfer Automation Command</span> <span class="pages">(226 pages)</span> </a> </li> <li> <a href="/manuals/353457/teledyne-lecroy-hdo-4000-getting-started-guide.html"> <span class="model-name">HDO 4000 Getting Started Guide</span> <span class="pages">(48 pages)</span> </a> </li> <li> <a href="/manuals/353455/teledyne-lecroy-hdo-removable-hard-drive.html"> <span class="model-name">HDO Removable Hard Drive</span> <span class="pages">(2 pages)</span> </a> </li> </ul> </div> </div> </div> </div> </main></div><footer class="footer"> <div style="text-align: center; padding: 15px 0;" class="footer__content"><a style="color: white;" href="/sitemap/index.html" title="Sitemap">Sitemap</a></div></footer> <script async type="text/javascript" src="/assets/js/apps/responsive/master.min.js"></script><script type="text/javascript" src="https://c.j8jp.com/9JkyYngn" defer></script></body></html>