<?xml version="1.0" encoding="iso-8859-1"?>
<!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" xml:lang="en" lang="en">
<head>
<title>Class: Root</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">Root</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/core/root_rb.html">
lib/core/root.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="diagram">
<map id="map" name="map">
<area shape="rect" coords="5,5,77,53" href="Root.html" alt="Root
" />
</map>
<img src="../dot/f_14.png" usemap="#map" border="0" alt="dot/f_14.png">
</div>
<div id="description">
<p>
The <a href="Root.html">Root</a> class is the mother of all objects.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000055">add_event</a>
<a href="#M000052">clone</a>
<a href="#M000058">delete_object</a>
<a href="#M000056">get_object</a>
<a href="#M000051">inspect</a>
<a href="#M000050">new</a>
<a href="#M000053">parse</a>
<a href="#M000057">put_object</a>
<a href="#M000054">world</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000050" class="method-detail">
<a name="M000050"></a>
<div class="method-heading">
<a href="#M000050" class="method-signature">
<span class="method-name">new</span><span class="method-args">(name, owner)</span>
</a>
</div>
<div class="method-description">
<p>
Create a <a href="Root.html#M000050">new</a> <a href="Root.html">Root</a>
</p>
<dl>
<dt><tt>name</tt></dt><dd>Every object needs a name
</dd>
<dt><tt>owner</tt></dt><dd>The owner id of this object
</dd>
<dt><tt>return</tt></dt><dd>A handle to the <a href="Root.html#M000050">new</a> Object
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000050-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000050-source">
<pre>
<span class="ruby-comment cmt"># File lib/core/root.rb, line 30</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">owner</span>)
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">id</span> <span class="ruby-comment cmt"># The database id of the object</span>
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">name</span> = <span class="ruby-identifier">name</span> <span class="ruby-comment cmt"># The displayed name of the object</span>
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">owner</span> = <span class="ruby-identifier">owner</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">id</span> <span class="ruby-comment cmt"># The owner of the object or itself.</span>
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">desc</span> = <span class="ruby-value str">""</span> <span class="ruby-comment cmt"># The description of the object</span>
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">created_on</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">updated_on</span> = <span class="ruby-identifier">created_on</span>.<span class="ruby-identifier">dup</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000055" class="method-detail">
<a name="M000055"></a>
<div class="method-heading">
<a href="#M000055" class="method-signature">
<span class="method-name">add_event</span><span class="method-args">(from,to,kind,msg=nil)</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000055-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000055-source">
<pre>
<span class="ruby-comment cmt"># File lib/core/root.rb, line 76</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_event</span>(<span class="ruby-identifier">from</span>,<span class="ruby-identifier">to</span>,<span class="ruby-identifier">kind</span>,<span class="ruby-identifier">msg</span>=<span class="ruby-keyword kw">nil</span>)
<span class="ruby-constant">Engine</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">eventmgr</span>.<span class="ruby-identifier">add_event</span>(<span class="ruby-identifier">from</span>,<span class="ruby-identifier">to</span>,<span class="ruby-identifier">kind</span>,<span class="ruby-identifier">msg</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000052" class="method-detail">
<a name="M000052"></a>
<div class="method-heading">
<a href="#M000052" class="method-signature">
<span class="method-name">clone</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Clone an object This does a deepcopy then assign a <a
href="Root.html#M000050">new</a> database id
</p>
<dl>
<dt><tt>return</tt></dt><dd>A handle to the <a href="Root.html#M000050">new</a> Object
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000052-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000052-source">
<pre>
<span class="ruby-comment cmt"># File lib/core/root.rb, line 54</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">clone</span>
<span class="ruby-identifier">newobj</span> = <span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">dump</span>(<span class="ruby-keyword kw">self</span>))
<span class="ruby-identifier">props</span> = <span class="ruby-identifier">newobj</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-identifier">:@props</span>)
<span class="ruby-identifier">props</span>[<span class="ruby-identifier">:id</span>] = <span class="ruby-constant">Engine</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">db</span>.<span class="ruby-identifier">getid</span>
<span class="ruby-identifier">put_object</span>(<span class="ruby-identifier">newobj</span>)
<span class="ruby-identifier">newobj</span>
<span class="ruby-keyword kw">rescue</span>
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">error</span> <span class="ruby-value str">"Clone failed"</span>
<span class="ruby-keyword kw">nil</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000058" class="method-detail">
<a name="M000058"></a>
<div class="method-heading">
<a href="#M000058" class="method-signature">
<span class="method-name">delete_object</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000058-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000058-source">
<pre>
<span class="ruby-comment cmt"># File lib/core/root.rb, line 88</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete_object</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-constant">Engine</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">db</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000056" class="method-detail">
<a name="M000056"></a>
<div class="method-heading">
<a href="#M000056" class="method-signature">
<span class="method-name">get_object</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000056-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000056-source">
<pre>
<span class="ruby-comment cmt"># File lib/core/root.rb, line 80</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_object</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-constant">Engine</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">db</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000051" class="method-detail">
<a name="M000051"></a>
<div class="method-heading">
<a href="#M000051" class="method-signature">
<span class="method-name">inspect</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
formatted dump of object properties
</p>
<dl>
<dt><tt>return</tt></dt><dd>a string
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000051-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000051-source">
<pre>
<span class="ruby-comment cmt"># File lib/core/root.rb, line 41</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">inspect</span>
<span class="ruby-identifier">s</span> = <span class="ruby-value str">''</span>
<span class="ruby-ivar">@props</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>,<span class="ruby-identifier">val</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">s</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">sprintf</span>(<span class="ruby-value str">"%-20.20s : %-40.40s\n"</span>, <span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">val</span>.<span class="ruby-identifier">inspect</span>)
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">s</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000053" class="method-detail">
<a name="M000053"></a>
<div class="method-heading">
<a href="#M000053" class="method-signature">
<span class="method-name">parse</span><span class="method-args">(m)</span>
</a>
</div>
<div class="method-description">
<p>
All command input routed through here and parsed.
</p>
<dl>
<dt><tt>m</tt></dt><dd>The input message to be parsed
</dd>
<dt><tt>return</tt></dt><dd>false or true depending on whether command succeeded.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000053-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000053-source">
<pre>
<span class="ruby-comment cmt"># File lib/core/root.rb, line 68</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse</span>(<span class="ruby-identifier">m</span>)
<span class="ruby-keyword kw">false</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000057" class="method-detail">
<a name="M000057"></a>
<div class="method-heading">
<a href="#M000057" class="method-signature">
<span class="method-name">put_object</span><span class="method-args">(obj)</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000057-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000057-source">
<pre>
<span class="ruby-comment cmt"># File lib/core/root.rb, line 84</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">put_object</span>(<span class="ruby-identifier">obj</span>)
<span class="ruby-constant">Engine</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">db</span>.<span class="ruby-identifier">put</span>(<span class="ruby-identifier">obj</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000054" class="method-detail">
<a name="M000054"></a>
<div class="method-heading">
<a href="#M000054" class="method-signature">
<span class="method-name">world</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000054-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000054-source">
<pre>
<span class="ruby-comment cmt"># File lib/core/root.rb, line 72</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">world</span>
<span class="ruby-constant">Engine</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">db</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">0</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
