343 lines
19 KiB
HTML
343 lines
19 KiB
HTML
<!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>template — pyogp.lib.base 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.lib.base v0.1 documentation" href="../index.html" />
|
|
<link rel="up" title="Modules" href="../modules.html" />
|
|
<link rel="next" title="template_dict" href="template_dict.html" />
|
|
<link rel="prev" title="stdlib_client" href="stdlib_client.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="template_dict.html" title="template_dict"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="stdlib_client.html" title="stdlib_client"
|
|
accesskey="P">previous</a> |</li>
|
|
<li><a href="../index.html">pyogp.lib.base v0.1 documentation</a> »</li>
|
|
<li><a href="../modules.html" accesskey="U">Modules</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="sphinxsidebar">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="stdlib_client.html"
|
|
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">stdlib_client</span></tt></a></p>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="template_dict.html"
|
|
title="next chapter"><tt class="docutils literal"><span class="pre">template_dict</span></tt></a></p>
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="../_sources/modules/template.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.template">
|
|
<h1><tt class="xref docutils literal"><span class="pre">template</span></tt><a class="headerlink" href="#module-pyogp.lib.base.message.template" title="Permalink to this headline">¶</a></h1>
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.message.template.MsgData">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.message.template.</tt><tt class="descname">MsgData</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgData" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Used as a Message that is being created that will be
|
|
serialized and sent.</p>
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MsgData.add_block">
|
|
<tt class="descname">add_block</tt><big>(</big><em>block</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgData.add_block" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MsgData.add_data">
|
|
<tt class="descname">add_data</tt><big>(</big><em>block_name</em>, <em>var_name</em>, <em>data</em>, <em>data_size</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgData.add_data" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MsgData.get_block">
|
|
<tt class="descname">get_block</tt><big>(</big><em>block_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgData.get_block" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.message.template.MsgBlockType">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.message.template.</tt><tt class="descname">MsgBlockType</tt><a class="headerlink" href="#pyogp.lib.base.message.template.MsgBlockType" title="Permalink to this definition">¶</a></dt>
|
|
<dd><dl class="classmethod">
|
|
<dt id="pyogp.lib.base.message.template.MsgBlockType.MBT_as_string">
|
|
<em class="property">
|
|
classmethod </em><tt class="descname">MBT_as_string</tt><big>(</big><em>typenum</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgBlockType.MBT_as_string" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplateVariable">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.message.template.</tt><tt class="descname">MessageTemplateVariable</tt><big>(</big><em>name</em>, <em>tp</em>, <em>size</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateVariable" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>TODO: Add docstring</p>
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplateVariable.get_name">
|
|
<tt class="descname">get_name</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateVariable.get_name" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplateVariable.get_type">
|
|
<tt class="descname">get_type</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateVariable.get_type" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplateVariable.get_type_as_string">
|
|
<tt class="descname">get_type_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateVariable.get_type_as_string" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplateBlock">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.message.template.</tt><tt class="descname">MessageTemplateBlock</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateBlock" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>TODO: Add docstring</p>
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplateBlock.add_variable">
|
|
<tt class="descname">add_variable</tt><big>(</big><em>var</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateBlock.add_variable" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplateBlock.get_block_number">
|
|
<tt class="descname">get_block_number</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateBlock.get_block_number" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplateBlock.get_block_type">
|
|
<tt class="descname">get_block_type</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateBlock.get_block_type" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplateBlock.get_block_type_as_string">
|
|
<tt class="descname">get_block_type_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateBlock.get_block_type_as_string" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplateBlock.get_name">
|
|
<tt class="descname">get_name</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateBlock.get_name" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplateBlock.get_variable">
|
|
<tt class="descname">get_variable</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateBlock.get_variable" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplateBlock.get_variables">
|
|
<tt class="descname">get_variables</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplateBlock.get_variables" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.message.template.MsgType">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.message.template.</tt><tt class="descname">MsgType</tt><a class="headerlink" href="#pyogp.lib.base.message.template.MsgType" title="Permalink to this definition">¶</a></dt>
|
|
<dd><dl class="classmethod">
|
|
<dt id="pyogp.lib.base.message.template.MsgType.MVT_as_string">
|
|
<em class="property">
|
|
classmethod </em><tt class="descname">MVT_as_string</tt><big>(</big><em>typenum</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgType.MVT_as_string" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplate">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.message.template.</tt><tt class="descname">MessageTemplate</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate" title="Permalink to this definition">¶</a></dt>
|
|
<dd><dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplate.add_block">
|
|
<tt class="descname">add_block</tt><big>(</big><em>block</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.add_block" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_block">
|
|
<tt class="descname">get_block</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_block" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_blocks">
|
|
<tt class="descname">get_blocks</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_blocks" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_deprecation">
|
|
<tt class="descname">get_deprecation</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_deprecation" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_deprecation_as_string">
|
|
<tt class="descname">get_deprecation_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_deprecation_as_string" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_frequency">
|
|
<tt class="descname">get_frequency</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_frequency" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_frequency_as_string">
|
|
<tt class="descname">get_frequency_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_frequency_as_string" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_message_encoding">
|
|
<tt class="descname">get_message_encoding</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_message_encoding" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_message_encoding_as_string">
|
|
<tt class="descname">get_message_encoding_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_message_encoding_as_string" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_message_hex_num">
|
|
<tt class="descname">get_message_hex_num</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_message_hex_num" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_message_number">
|
|
<tt class="descname">get_message_number</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_message_number" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_message_trust">
|
|
<tt class="descname">get_message_trust</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_message_trust" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_message_trust_as_string">
|
|
<tt class="descname">get_message_trust_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_message_trust_as_string" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MessageTemplate.get_name">
|
|
<tt class="descname">get_name</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MessageTemplate.get_name" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.message.template.MsgVariableData">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.message.template.</tt><tt class="descname">MsgVariableData</tt><big>(</big><em>name</em>, <em>data</em>, <em>var_type=None</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgVariableData" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Used as a Message Block variable that is being created that will be
|
|
serialized and sent</p>
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MsgVariableData.get_data_as_string">
|
|
<tt class="descname">get_data_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgVariableData.get_data_as_string" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MsgVariableData.get_var_type_as_string">
|
|
<tt class="descname">get_var_type_as_string</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgVariableData.get_var_type_as_string" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="pyogp.lib.base.message.template.MsgBlockData">
|
|
<em class="property">
|
|
class </em><tt class="descclassname">pyogp.lib.base.message.template.</tt><tt class="descname">MsgBlockData</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgBlockData" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Used as a Message block that is being created that will be
|
|
serialized and sent.</p>
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MsgBlockData.add_variable">
|
|
<tt class="descname">add_variable</tt><big>(</big><em>var</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgBlockData.add_variable" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MsgBlockData.get_variable">
|
|
<tt class="descname">get_variable</tt><big>(</big><em>var_name</em><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgBlockData.get_variable" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="pyogp.lib.base.message.template.MsgBlockData.get_variables">
|
|
<tt class="descname">get_variables</tt><big>(</big><big>)</big><a class="headerlink" href="#pyogp.lib.base.message.template.MsgBlockData.get_variables" 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="template_dict.html" title="template_dict"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="stdlib_client.html" title="stdlib_client"
|
|
>previous</a> |</li>
|
|
<li><a href="../index.html">pyogp.lib.base v0.1 documentation</a> »</li>
|
|
<li><a href="../modules.html" >Modules</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer">
|
|
© Copyright 2009, Pyogp team.
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
|
|
</div>
|
|
</body>
|
|
</html> |