BOSWatch/BW3-Core
1
0
Fork 0
mirror of https://github.com/BOSWatch/BW3-Core.git synced 2026-01-01 14:20:28 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
BW3-Core/api/html/namespaceboswatch_1_1wildcard.html

295 lines
22 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BOSWatch 3: boswatch.wildcard Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">BOSWatch 3
</div>
<div id="projectbrief">Python Script to receive and decode German BOS Information with rtl_fm and multimon-NG</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('namespaceboswatch_1_1wildcard.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">boswatch.wildcard Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae98b70e53f0ce7080beda385f2f9e1f7" id="r_ae98b70e53f0ce7080beda385f2f9e1f7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae98b70e53f0ce7080beda385f2f9e1f7">registerWildcard</a> (wildcard, bwPacketField)</td></tr>
<tr class="memdesc:ae98b70e53f0ce7080beda385f2f9e1f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a new additional wildcard. <br /></td></tr>
<tr class="separator:ae98b70e53f0ce7080beda385f2f9e1f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa05203c39c351fa3983c50fd84aea46b" id="r_aa05203c39c351fa3983c50fd84aea46b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa05203c39c351fa3983c50fd84aea46b">replaceWildcards</a> (message, bwPacket)</td></tr>
<tr class="memdesc:aa05203c39c351fa3983c50fd84aea46b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replace the wildcards in a given message. <br /></td></tr>
<tr class="separator:aa05203c39c351fa3983c50fd84aea46b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a3bb21b17cf726f8a3ccf52db774a369e" id="r_a3bb21b17cf726f8a3ccf52db774a369e"><td class="memItemLeft" align="right" valign="top">dict&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3bb21b17cf726f8a3ccf52db774a369e">_additionalWildcards</a> = {}</td></tr>
<tr class="separator:a3bb21b17cf726f8a3ccf52db774a369e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><hr />
<p> / __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ / / __ / / / /__ | | /| / / __ `/ __/ ___/ __ \ /_ &lt; / /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ / /_____/____//____/ |__/|__/__,_/__/___/_/ /_/ /____/ German BOS Information Script by Bastian Schroll </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ae98b70e53f0ce7080beda385f2f9e1f7" name="ae98b70e53f0ce7080beda385f2f9e1f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae98b70e53f0ce7080beda385f2f9e1f7">&#9670;&#160;</a></span>registerWildcard()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boswatch.wildcard.registerWildcard </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>wildcard</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>bwPacketField</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Register a new additional wildcard. </p>
<pre class="fragment">@param wildcard: New wildcard string with format: '{WILDCARD}'
@param bwPacketField: Field of the bwPacket which is used for wildcard replacement
</pre> <div class="fragment"><div class="line"><span class="lineno"> 27</span><span class="keyword">def </span>registerWildcard(wildcard, bwPacketField):</div>
<div class="line"><span class="lineno"> 28</span> <span class="stringliteral">r&quot;&quot;&quot;!Register a new additional wildcard</span></div>
<div class="line"><span class="lineno"> 29</span><span class="stringliteral"></span> </div>
<div class="line"><span class="lineno"> 30</span><span class="stringliteral"> @param wildcard: New wildcard string with format: &#39;{WILDCARD}&#39;</span></div>
<div class="line"><span class="lineno"> 31</span><span class="stringliteral"> @param bwPacketField: Field of the bwPacket which is used for wildcard replacement&quot;&quot;&quot;</span></div>
<div class="line"><span class="lineno"> 32</span> <span class="keywordflow">if</span> wildcard <span class="keywordflow">in</span> _additionalWildcards:</div>
<div class="line"><span class="lineno"> 33</span> logging.error(<span class="stringliteral">&quot;wildcard always registered: %s&quot;</span>, wildcard)</div>
<div class="line"><span class="lineno"> 34</span> <span class="keywordflow">return</span></div>
<div class="line"><span class="lineno"> 35</span> logging.debug(<span class="stringliteral">&quot;register new wildcard %s for field: %s&quot;</span>, wildcard, bwPacketField)</div>
<div class="line"><span class="lineno"> 36</span> _additionalWildcards[wildcard] = bwPacketField</div>
<div class="line"><span class="lineno"> 37</span> </div>
<div class="line"><span class="lineno"> 38</span> </div>
</div><!-- fragment -->
</div>
</div>
<a id="aa05203c39c351fa3983c50fd84aea46b" name="aa05203c39c351fa3983c50fd84aea46b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa05203c39c351fa3983c50fd84aea46b">&#9670;&#160;</a></span>replaceWildcards()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boswatch.wildcard.replaceWildcards </td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>message</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>bwPacket</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Replace the wildcards in a given message. </p>
<pre class="fragment">@param message: Message in which wildcards should be replaced
@param bwPacket: bwPacket instance with the replacement information
@return Input message with the replaced wildcards
</pre> <div class="fragment"><div class="line"><span class="lineno"> 39</span><span class="keyword">def </span>replaceWildcards(message, bwPacket):</div>
<div class="line"><span class="lineno"> 40</span> <span class="stringliteral">r&quot;&quot;&quot;!Replace the wildcards in a given message</span></div>
<div class="line"><span class="lineno"> 41</span><span class="stringliteral"></span> </div>
<div class="line"><span class="lineno"> 42</span><span class="stringliteral"> @param message: Message in which wildcards should be replaced</span></div>
<div class="line"><span class="lineno"> 43</span><span class="stringliteral"> @param bwPacket: bwPacket instance with the replacement information</span></div>
<div class="line"><span class="lineno"> 44</span><span class="stringliteral"> @return Input message with the replaced wildcards&quot;&quot;&quot;</span></div>
<div class="line"><span class="lineno"> 45</span> _wildcards = {</div>
<div class="line"><span class="lineno"> 46</span> <span class="comment"># formatting wildcards</span></div>
<div class="line"><span class="lineno"> 47</span> <span class="comment"># todo check if br and par are needed - if not also change config</span></div>
<div class="line"><span class="lineno"> 48</span> <span class="stringliteral">&quot;{BR}&quot;</span>: <span class="stringliteral">&quot;\r\n&quot;</span>,</div>
<div class="line"><span class="lineno"> 49</span> <span class="stringliteral">&quot;{LPAR}&quot;</span>: <span class="stringliteral">&quot;(&quot;</span>,</div>
<div class="line"><span class="lineno"> 50</span> <span class="stringliteral">&quot;{RPAR}&quot;</span>: <span class="stringliteral">&quot;)&quot;</span>,</div>
<div class="line"><span class="lineno"> 51</span> <span class="stringliteral">&quot;{TIME}&quot;</span>: time.strftime(<span class="stringliteral">&quot;%d.%m.%Y %H:%M:%S&quot;</span>),</div>
<div class="line"><span class="lineno"> 52</span> </div>
<div class="line"><span class="lineno"> 53</span> <span class="comment"># info wildcards</span></div>
<div class="line"><span class="lineno"> 54</span> <span class="comment"># server</span></div>
<div class="line"><span class="lineno"> 55</span> <span class="stringliteral">&quot;{SNAME}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;serverName&quot;</span>),</div>
<div class="line"><span class="lineno"> 56</span> <span class="stringliteral">&quot;{SVERS}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;serverVersion&quot;</span>),</div>
<div class="line"><span class="lineno"> 57</span> <span class="stringliteral">&quot;{SDATE}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;serverBuildDate&quot;</span>),</div>
<div class="line"><span class="lineno"> 58</span> <span class="stringliteral">&quot;{SBRCH}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;serverBranch&quot;</span>),</div>
<div class="line"><span class="lineno"> 59</span> </div>
<div class="line"><span class="lineno"> 60</span> <span class="comment"># client</span></div>
<div class="line"><span class="lineno"> 61</span> <span class="stringliteral">&quot;{CNAME}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;clientName&quot;</span>),</div>
<div class="line"><span class="lineno"> 62</span> <span class="stringliteral">&quot;{CIP}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;clientIP&quot;</span>),</div>
<div class="line"><span class="lineno"> 63</span> <span class="stringliteral">&quot;{CVERS}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;clientVersion&quot;</span>),</div>
<div class="line"><span class="lineno"> 64</span> <span class="stringliteral">&quot;{CDATE}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;clientBuildDate&quot;</span>),</div>
<div class="line"><span class="lineno"> 65</span> <span class="stringliteral">&quot;{CBRCH}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;clientBranch&quot;</span>),</div>
<div class="line"><span class="lineno"> 66</span> </div>
<div class="line"><span class="lineno"> 67</span> <span class="comment"># boswatch wildcards</span></div>
<div class="line"><span class="lineno"> 68</span> <span class="stringliteral">&quot;{INSRC}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;inputSource&quot;</span>),</div>
<div class="line"><span class="lineno"> 69</span> <span class="stringliteral">&quot;{TIMES}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;timestamp&quot;</span>),</div>
<div class="line"><span class="lineno"> 70</span> <span class="stringliteral">&quot;{FREQ}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;frequency&quot;</span>),</div>
<div class="line"><span class="lineno"> 71</span> <span class="stringliteral">&quot;{MODE}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;mode&quot;</span>),</div>
<div class="line"><span class="lineno"> 72</span> </div>
<div class="line"><span class="lineno"> 73</span> <span class="comment"># fms wildcards</span></div>
<div class="line"><span class="lineno"> 74</span> <span class="stringliteral">&quot;{FMS}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;fms&quot;</span>),</div>
<div class="line"><span class="lineno"> 75</span> <span class="stringliteral">&quot;{SERV}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;service&quot;</span>),</div>
<div class="line"><span class="lineno"> 76</span> <span class="stringliteral">&quot;{COUNT}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;country&quot;</span>),</div>
<div class="line"><span class="lineno"> 77</span> <span class="stringliteral">&quot;{LOC}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;location&quot;</span>),</div>
<div class="line"><span class="lineno"> 78</span> <span class="stringliteral">&quot;{VEHC}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;vehicle&quot;</span>),</div>
<div class="line"><span class="lineno"> 79</span> <span class="stringliteral">&quot;{STAT}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;status&quot;</span>),</div>
<div class="line"><span class="lineno"> 80</span> <span class="stringliteral">&quot;{DIR}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;direction&quot;</span>),</div>
<div class="line"><span class="lineno"> 81</span> <span class="stringliteral">&quot;{DIRT}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;directionText&quot;</span>),</div>
<div class="line"><span class="lineno"> 82</span> <span class="stringliteral">&quot;{TACI}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;tacticalInfo&quot;</span>),</div>
<div class="line"><span class="lineno"> 83</span> </div>
<div class="line"><span class="lineno"> 84</span> <span class="comment"># pocsag wildcards</span></div>
<div class="line"><span class="lineno"> 85</span> <span class="stringliteral">&quot;{BIT}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;bitrate&quot;</span>),</div>
<div class="line"><span class="lineno"> 86</span> <span class="stringliteral">&quot;{RIC}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;ric&quot;</span>),</div>
<div class="line"><span class="lineno"> 87</span> <span class="stringliteral">&quot;{SRIC}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;subric&quot;</span>),</div>
<div class="line"><span class="lineno"> 88</span> <span class="stringliteral">&quot;{SRICT}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;subricText&quot;</span>),</div>
<div class="line"><span class="lineno"> 89</span> <span class="stringliteral">&quot;{MSG}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;message&quot;</span>),</div>
<div class="line"><span class="lineno"> 90</span> </div>
<div class="line"><span class="lineno"> 91</span> <span class="comment"># zvei wildcards</span></div>
<div class="line"><span class="lineno"> 92</span> <span class="stringliteral">&quot;{TONE}&quot;</span>: bwPacket.get(<span class="stringliteral">&quot;tone&quot;</span>),</div>
<div class="line"><span class="lineno"> 93</span> </div>
<div class="line"><span class="lineno"> 94</span> <span class="comment"># message for MSG packet is done in poc</span></div>
<div class="line"><span class="lineno"> 95</span> }</div>
<div class="line"><span class="lineno"> 96</span> <span class="keywordflow">for</span> wildcard, field <span class="keywordflow">in</span> _wildcards.items():</div>
<div class="line"><span class="lineno"> 97</span> <span class="keywordflow">if</span> field <span class="keywordflow">is</span> <span class="keywordflow">not</span> <span class="keywordtype">None</span>:</div>
<div class="line"><span class="lineno"> 98</span> message = message.replace(wildcard, field)</div>
<div class="line"><span class="lineno"> 99</span> </div>
<div class="line"><span class="lineno"> 100</span> <span class="keywordflow">for</span> wildcard, fieldName <span class="keywordflow">in</span> _additionalWildcards.items():</div>
<div class="line"><span class="lineno"> 101</span> field = bwPacket.get(fieldName)</div>
<div class="line"><span class="lineno"> 102</span> <span class="keywordflow">if</span> field <span class="keywordflow">is</span> <span class="keywordflow">not</span> <span class="keywordtype">None</span>:</div>
<div class="line"><span class="lineno"> 103</span> message = message.replace(wildcard, field)</div>
<div class="line"><span class="lineno"> 104</span> </div>
<div class="line"><span class="lineno"> 105</span> <span class="keywordflow">return</span> message</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a3bb21b17cf726f8a3ccf52db774a369e" name="a3bb21b17cf726f8a3ccf52db774a369e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bb21b17cf726f8a3ccf52db774a369e">&#9670;&#160;</a></span>_additionalWildcards</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">dict boswatch.wildcard._additionalWildcards = {}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceboswatch.html">boswatch</a></li><li class="navelem"><a class="el" href="namespaceboswatch_1_1wildcard.html">wildcard</a></li>
<li class="footer">Generated on Wed Jun 11 2025 08:24:06 for BOSWatch 3 by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink