add sphinx documentation
[nepi.git] / doc / sphinx / _build / html / _layout / nepi.data.processing.ccn.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5 <html xmlns="http://www.w3.org/1999/xhtml">
6   <head>
7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8     
9     <title>nepi.data.processing.ccn package &mdash; NEPI 3.0 documentation</title>
10     
11     <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
12     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13     
14     <script type="text/javascript">
15       var DOCUMENTATION_OPTIONS = {
16         URL_ROOT:    '../',
17         VERSION:     '3.0',
18         COLLAPSE_INDEX: false,
19         FILE_SUFFIX: '.html',
20         HAS_SOURCE:  true
21       };
22     </script>
23     <script type="text/javascript" src="../_static/jquery.js"></script>
24     <script type="text/javascript" src="../_static/underscore.js"></script>
25     <script type="text/javascript" src="../_static/doctools.js"></script>
26     <link rel="top" title="NEPI 3.0 documentation" href="../index.html" /> 
27   </head>
28   <body>
29     <div class="related">
30       <h3>Navigation</h3>
31       <ul>
32         <li class="right" style="margin-right: 10px">
33           <a href="../genindex.html" title="General Index"
34              accesskey="I">index</a></li>
35         <li class="right" >
36           <a href="../py-modindex.html" title="Python Module Index"
37              >modules</a> |</li>
38         <li><a href="../index.html">NEPI 3.0 documentation</a> &raquo;</li> 
39       </ul>
40     </div>
41       <div class="sphinxsidebar">
42         <div class="sphinxsidebarwrapper">
43   <h3><a href="../index.html">Table Of Contents</a></h3>
44   <ul>
45 <li><a class="reference internal" href="#">nepi.data.processing.ccn package</a><ul>
46 <li><a class="reference internal" href="#submodules">Submodules</a></li>
47 <li><a class="reference internal" href="#module-nepi.data.processing.ccn.parser">nepi.data.processing.ccn.parser module</a></li>
48 <li><a class="reference internal" href="#module-nepi.data.processing.ccn">Module contents</a></li>
49 </ul>
50 </li>
51 </ul>
52
53   <h3>This Page</h3>
54   <ul class="this-page-menu">
55     <li><a href="../_sources/_layout/nepi.data.processing.ccn.txt"
56            rel="nofollow">Show Source</a></li>
57   </ul>
58 <div id="searchbox" style="display: none">
59   <h3>Quick search</h3>
60     <form class="search" action="../search.html" method="get">
61       <input type="text" name="q" />
62       <input type="submit" value="Go" />
63       <input type="hidden" name="check_keywords" value="yes" />
64       <input type="hidden" name="area" value="default" />
65     </form>
66     <p class="searchtip" style="font-size: 90%">
67     Enter search terms or a module, class or function name.
68     </p>
69 </div>
70 <script type="text/javascript">$('#searchbox').show(0);</script>
71         </div>
72       </div>
73
74     <div class="document">
75       <div class="documentwrapper">
76         <div class="bodywrapper">
77           <div class="body">
78             
79   <div class="section" id="nepi-data-processing-ccn-package">
80 <h1>nepi.data.processing.ccn package<a class="headerlink" href="#nepi-data-processing-ccn-package" title="Permalink to this headline">¶</a></h1>
81 <div class="section" id="submodules">
82 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
83 </div>
84 <div class="section" id="module-nepi.data.processing.ccn.parser">
85 <span id="nepi-data-processing-ccn-parser-module"></span><h2>nepi.data.processing.ccn.parser module<a class="headerlink" href="#module-nepi.data.processing.ccn.parser" title="Permalink to this headline">¶</a></h2>
86 <dl class="function">
87 <dt id="nepi.data.processing.ccn.parser.annotate_cn_graph">
88 <tt class="descclassname">nepi.data.processing.ccn.parser.</tt><tt class="descname">annotate_cn_graph</tt><big>(</big><em>logs_dir</em>, <em>graph</em>, <em>parse_ping_logs=False</em><big>)</big><a class="reference internal" href="../_modules/nepi/data/processing/ccn/parser.html#annotate_cn_graph"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.data.processing.ccn.parser.annotate_cn_graph" title="Permalink to this definition">¶</a></dt>
89 <dd><p>Adds CCN content history for each node in the topology graph.</p>
90 </dd></dl>
91
92 <dl class="function">
93 <dt id="nepi.data.processing.ccn.parser.annotate_cn_node">
94 <tt class="descclassname">nepi.data.processing.ccn.parser.</tt><tt class="descname">annotate_cn_node</tt><big>(</big><em>graph</em>, <em>nid</em>, <em>ips2nid</em>, <em>data</em>, <em>content_history</em><big>)</big><a class="reference internal" href="../_modules/nepi/data/processing/ccn/parser.html#annotate_cn_node"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.data.processing.ccn.parser.annotate_cn_node" title="Permalink to this definition">¶</a></dt>
95 <dd></dd></dl>
96
97 <dl class="function">
98 <dt id="nepi.data.processing.ccn.parser.ccn_consumers">
99 <tt class="descclassname">nepi.data.processing.ccn.parser.</tt><tt class="descname">ccn_consumers</tt><big>(</big><em>graph</em><big>)</big><a class="reference internal" href="../_modules/nepi/data/processing/ccn/parser.html#ccn_consumers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.data.processing.ccn.parser.ccn_consumers" title="Permalink to this definition">¶</a></dt>
100 <dd><p>Returns the nodes that are content consumers</p>
101 </dd></dl>
102
103 <dl class="function">
104 <dt id="nepi.data.processing.ccn.parser.ccn_producers">
105 <tt class="descclassname">nepi.data.processing.ccn.parser.</tt><tt class="descname">ccn_producers</tt><big>(</big><em>graph</em><big>)</big><a class="reference internal" href="../_modules/nepi/data/processing/ccn/parser.html#ccn_producers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.data.processing.ccn.parser.ccn_producers" title="Permalink to this definition">¶</a></dt>
106 <dd><p>Returns the nodes that are content providers</p>
107 </dd></dl>
108
109 <dl class="function">
110 <dt id="nepi.data.processing.ccn.parser.dump_content_history">
111 <tt class="descclassname">nepi.data.processing.ccn.parser.</tt><tt class="descname">dump_content_history</tt><big>(</big><em>content_history</em><big>)</big><a class="reference internal" href="../_modules/nepi/data/processing/ccn/parser.html#dump_content_history"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.data.processing.ccn.parser.dump_content_history" title="Permalink to this definition">¶</a></dt>
112 <dd></dd></dl>
113
114 <dl class="function">
115 <dt id="nepi.data.processing.ccn.parser.is_control">
116 <tt class="descclassname">nepi.data.processing.ccn.parser.</tt><tt class="descname">is_control</tt><big>(</big><em>content_name</em><big>)</big><a class="reference internal" href="../_modules/nepi/data/processing/ccn/parser.html#is_control"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.data.processing.ccn.parser.is_control" title="Permalink to this definition">¶</a></dt>
117 <dd></dd></dl>
118
119 <dl class="function">
120 <dt id="nepi.data.processing.ccn.parser.load_content_history">
121 <tt class="descclassname">nepi.data.processing.ccn.parser.</tt><tt class="descname">load_content_history</tt><big>(</big><em>fname</em><big>)</big><a class="reference internal" href="../_modules/nepi/data/processing/ccn/parser.html#load_content_history"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.data.processing.ccn.parser.load_content_history" title="Permalink to this definition">¶</a></dt>
122 <dd></dd></dl>
123
124 <dl class="function">
125 <dt id="nepi.data.processing.ccn.parser.parse_file">
126 <tt class="descclassname">nepi.data.processing.ccn.parser.</tt><tt class="descname">parse_file</tt><big>(</big><em>filename</em><big>)</big><a class="reference internal" href="../_modules/nepi/data/processing/ccn/parser.html#parse_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.data.processing.ccn.parser.parse_file" title="Permalink to this definition">¶</a></dt>
127 <dd><p>Parses message information from ccnd log files</p>
128 <p>filename: path to ccndlog file</p>
129 </dd></dl>
130
131 <dl class="function">
132 <dt id="nepi.data.processing.ccn.parser.process_content_history">
133 <tt class="descclassname">nepi.data.processing.ccn.parser.</tt><tt class="descname">process_content_history</tt><big>(</big><em>graph</em><big>)</big><a class="reference internal" href="../_modules/nepi/data/processing/ccn/parser.html#process_content_history"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.data.processing.ccn.parser.process_content_history" title="Permalink to this definition">¶</a></dt>
134 <dd><p>Compute CCN message counts and aggregates content historical 
135 information in the content_names dictionary</p>
136 </dd></dl>
137
138 <dl class="function">
139 <dt id="nepi.data.processing.ccn.parser.process_content_history_logs">
140 <tt class="descclassname">nepi.data.processing.ccn.parser.</tt><tt class="descname">process_content_history_logs</tt><big>(</big><em>logs_dir</em>, <em>graph</em>, <em>parse_ping_logs=False</em><big>)</big><a class="reference internal" href="../_modules/nepi/data/processing/ccn/parser.html#process_content_history_logs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.data.processing.ccn.parser.process_content_history_logs" title="Permalink to this definition">¶</a></dt>
141 <dd><p>Parse CCN logs and aggregate content history information in graph.
142 Returns annotated graph and message countn and content names history.</p>
143 </dd></dl>
144
145 </div>
146 <div class="section" id="module-nepi.data.processing.ccn">
147 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-nepi.data.processing.ccn" title="Permalink to this headline">¶</a></h2>
148 </div>
149 </div>
150
151
152           </div>
153         </div>
154       </div>
155       <div class="clearer"></div>
156     </div>
157     <div class="related">
158       <h3>Navigation</h3>
159       <ul>
160         <li class="right" style="margin-right: 10px">
161           <a href="../genindex.html" title="General Index"
162              >index</a></li>
163         <li class="right" >
164           <a href="../py-modindex.html" title="Python Module Index"
165              >modules</a> |</li>
166         <li><a href="../index.html">NEPI 3.0 documentation</a> &raquo;</li> 
167       </ul>
168     </div>
169     <div class="footer">
170         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
171       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
172     </div>
173   </body>
174 </html>