source: ammosreader/public/_modules/ammosreader/AmmosSingleFrame.html@ 93661be

AmmosSource guix
Last change on this file since 93661be was 93661be, checked in by Enrico Schwass <ennoausberlin@…>, 3 years ago

sphinx-apidoc run again

  • Property mode set to 100644
File size: 9.7 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4<html>
5 <head>
6 <meta charset="utf-8" />
7 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
8 <title>ammosreader.AmmosSingleFrame &#8212; AmmosReader 0.314 documentation</title>
9 <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
10 <link rel="stylesheet" type="text/css" href="../../_static/css/adctheme.css" />
11 <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
12 <script src="../../_static/jquery.js"></script>
13 <script src="../../_static/underscore.js"></script>
14 <script src="../../_static/doctools.js"></script>
15 <meta name="generator" content="Sphinx/ADC Theme by Mirounga www.mirounga.fr"/>
16 <link rel="index" title="Index" href="../../genindex.html" />
17 <link rel="search" title="Search" href="../../search.html" />
18 <link rel="top" title="AmmosReader 0.314 documentation" href="../../index.html" />
19 <link rel="up" title="Module code" href="../index.html" />
20 <link media="only screen and (max-device-width: 480px)" href="../../_static/css/mobile.css" type="text/css" rel="stylesheet" />
21 </head><body>
22<div id="docstitle">
23 <p>AmmosReader 0.314 documentation</p>
24</div>
25<div id="header">
26 <div id="title"><h1>ammosreader.AmmosSingleFrame</h1></div>
27 <ul id="headerButtons">
28 <li id="toc_button"><div class="headerButton"><a href="#">Table of Contents</a></div></li>
29 <li id="page_buttons">
30 <div class="headerButton"><a href="../../genindex.html" title="General Index" accesskey="I">index</a></div>
31 <div class="headerButton"><a href="../../py-modindex.html" title="Python Module Index" >modules</a></div>
32 </li>
33 </ul>
34</div>
35
36<div id="sphinxsidebar">
37 <div class="sphinxsidebarwrapper">
38 <ul><li class="toctree-l1"><a href="../../index.html">Main Page</a></li></ul>
39 <ul>
40<li class="toctree-l1"><a class="reference internal" href="../../ammosreader.html">ammosreader package</a></li>
41</ul>
42
43 <div id="searchbox" style="display: none">
44 <form class="search" action="../../search.html" method="get">
45 <div class="search-wrapper">
46 <input type="submit" value="" class="search-left"/>
47 <input class="prettysearch" type="text" name="q" size="18" title="Enter search terms or a module, class or function name."/>
48 <span class="search-right">&nbsp;</span>
49 </div>
50 <input type="hidden" name="check_keywords" value="yes" />
51 <input type="hidden" name="area" value="default" />
52 </form>
53 </div>
54 <script type="text/javascript">$('#searchbox').show(0);</script>
55 </div>
56</div>
57
58
59
60 <div class="document">
61 <div class="documentwrapper">
62 <div class="bodywrapper">
63 <div class="body">
64
65 <h1>Source code for ammosreader.AmmosSingleFrame</h1><div class="highlight"><pre>
66<div class="viewcode-block" id="AmmosSingleFrame"><a class="viewcode-back" href="../../ammosreader.html#ammosreader.AmmosSingleFrame.AmmosSingleFrame">[docs]</a><span></span><span class="k">class</span> <span class="nc">AmmosSingleFrame</span><span class="p">():</span>
67
68 <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">global_frame_header</span><span class="p">,</span> <span class="n">global_frame_body</span><span class="p">):</span>
69 <span class="bp">self</span><span class="o">.</span><span class="n">__global_frame_header</span> <span class="o">=</span> <span class="n">global_frame_header</span>
70 <span class="bp">self</span><span class="o">.</span><span class="n">__global_frame_body</span> <span class="o">=</span> <span class="n">global_frame_body</span>
71
72 <span class="nd">@property</span>
73 <span class="k">def</span> <span class="nf">global_frame_header</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
74 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__global_frame_header</span>
75
76 <span class="nd">@property</span>
77 <span class="k">def</span> <span class="nf">global_frame_body</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
78 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__global_frame_body</span>
79
80<div class="viewcode-block" id="AmmosSingleFrame.data"><a class="viewcode-back" href="../../ammosreader.html#ammosreader.AmmosSingleFrame.AmmosSingleFrame.data">[docs]</a> <span class="k">def</span> <span class="nf">data</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
81 <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">global_frame_body</span><span class="o">.</span><span class="n">data_bytes_only</span><span class="p">()</span></div>
82
83<div class="viewcode-block" id="AmmosSingleFrame.size_correct"><a class="viewcode-back" href="../../ammosreader.html#ammosreader.AmmosSingleFrame.AmmosSingleFrame.size_correct">[docs]</a> <span class="k">def</span> <span class="nf">size_correct</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
84 <span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">global_frame_header</span><span class="o">.</span><span class="n">frame_length</span> <span class="o">==</span> <span class="p">(</span><span class="mi">24</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">global_frame_header</span><span class="o">.</span><span class="n">data_header_length</span> <span class="o">+</span>
85 <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">global_frame_body</span><span class="o">.</span><span class="n">data_header</span><span class="o">.</span><span class="n">block_count</span> <span class="o">*</span>
86 <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">global_frame_body</span><span class="o">.</span><span class="n">data_header</span><span class="o">.</span><span class="n">block_length</span> <span class="o">+</span> <span class="mi">4</span><span class="p">))))</span></div>
87 <span class="c1"># FIXME: Use str method instead</span>
88
89 <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
90 <span class="n">output</span> <span class="o">=</span> <span class="p">(</span>
91 <span class="s2">&quot;Global frame header</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">+</span>
92 <span class="s2">&quot;-------------------</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">+</span>
93 <span class="s2">&quot;Frame type:&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">global_frame_header</span><span class="o">.</span><span class="n">frame_type</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">+</span>
94 <span class="s2">&quot;Frame count:&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">global_frame_header</span><span class="o">.</span><span class="n">running_frame_number</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">+</span>
95 <span class="s2">&quot;Data header length:&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">global_frame_header</span><span class="o">.</span><span class="n">data_header_length</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot; bytes</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">+</span>
96 <span class="s2">&quot;Frame length:&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">global_frame_header</span><span class="o">.</span><span class="n">frame_length</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot; bytes</span><span class="se">\n</span><span class="s2">&quot;</span>
97 <span class="p">)</span>
98 <span class="k">return</span> <span class="n">output</span></div>
99</pre></div>
100
101 </div>
102 </div>
103 </div>
104 <div class="footer">
105 <p>
106 &copy; Copyright 2022, KIDZg.
107 Created using <a href="http://www.sphinx-doc.org/">Sphinx</a> 4.5.0 <a href="https://github.com/mga-sphinx/sphinx_adc_theme">ADC Theme</a> .
108 (Revision )
109 </p>
110 </div>
111 <div class="clearer"></div>
112 </div>
113 <div id="breadcrumbs">
114 <a href="../index.html" accesskey="U">Module code</a><img src="../../_static/img/triangle_closed.png" height="9" width="9" alt="&gt;">
115 ammosreader.AmmosSingleFrame
116 </div>
117 <script type="text/javascript" charset="utf-8" src="../../_static/js/toc.js"></script>
118 </body>
119</html>
Note: See TracBrowser for help on using the repository browser.