moving docs out of the base lib

This commit is contained in:
enus.linden
2009-04-27 22:55:40 +00:00
committed by Salad Dais
parent ea5c1a62eb
commit 273ee5a6ba
405 changed files with 0 additions and 37570 deletions

View File

@@ -1,139 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>factory &mdash; Pyogp v0.1 documentation</title>
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.1',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="Pyogp v0.1 documentation" href="../index.html" />
<link rel="up" title="Modules" href="../modules.html" />
<link rel="next" title="groups" href="groups.html" />
<link rel="prev" title="exc" href="exc.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="groups.html" title="groups"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="exc.html" title="exc"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">Pyogp v0.1 documentation</a> &raquo;</li>
<li><a href="../modules.html" accesskey="U">Modules</a> &raquo;</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="exc.html"
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">exc</span></tt></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="groups.html"
title="next chapter"><tt class="docutils literal"><span class="pre">groups</span></tt></a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/modules/factory.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-pyogp.lib.base.message.factory">
<h1><tt class="xref docutils literal"><span class="pre">factory</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.factory" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="pyogp.lib.base.message.factory.MessageFactory">
<em class="property">
class </em><tt class="descclassname">pyogp.lib.base.message.factory.</tt><tt class="descname">MessageFactory</tt><a class="headerlink" href="#pyogp.lib.base.message.factory.MessageFactory" title="Permalink to this definition"></a></dt>
<dd><dl class="method">
<dt id="pyogp.lib.base.message.factory.MessageFactory.add_data">
<tt class="descname">add_data</tt><big>(</big><em>var_name</em>, <em>data</em>, <em>data_type</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.factory.MessageFactory.add_data" title="Permalink to this definition"></a></dt>
<dd>the data type is passed in to make sure that the programmer is aware of
what type (and therefore size) of the data that is being passed in.</dd></dl>
<dl class="method">
<dt id="pyogp.lib.base.message.factory.MessageFactory.new_message">
<tt class="descname">new_message</tt><big>(</big><em>message_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.factory.MessageFactory.new_message" title="Permalink to this definition"></a></dt>
<dd>Creates a new packet where data can be added to it. Note, the variables
are added when they are used, or data added to them, so to make sure
no bad data is sent over the network.</dd></dl>
<dl class="method">
<dt id="pyogp.lib.base.message.factory.MessageFactory.next_block">
<tt class="descname">next_block</tt><big>(</big><em>block_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.factory.MessageFactory.next_block" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../modindex.html" title="Global Module Index"
>modules</a> |</li>
<li class="right" >
<a href="groups.html" title="groups"
>next</a> |</li>
<li class="right" >
<a href="exc.html" title="exc"
>previous</a> |</li>
<li><a href="../index.html">Pyogp v0.1 documentation</a> &raquo;</li>
<li><a href="../modules.html" >Modules</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2009, Pyogp team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
</div>
</body>
</html>