1 <?xml version="1.0" encoding="iso-8859-1"?>
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8 <title>Class: MCollective::Aggregate::Result::Base</title>
9 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10 <meta http-equiv="Content-Script-Type" content="text/javascript" />
11 <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
12 <script type="text/javascript">
15 function popupCode( url ) {
16 window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
19 function toggleCode( id ) {
20 if ( document.getElementById )
21 elem = document.getElementById( id );
22 else if ( document.all )
23 elem = eval( "document.all." + id );
27 elemStyle = elem.style;
29 if ( elemStyle.display != "block" ) {
30 elemStyle.display = "block"
32 elemStyle.display = "none"
38 // Make codeblocks hidden by default
39 document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
49 <div id="classHeader">
50 <table class="header-table">
51 <tr class="top-aligned-row">
52 <td><strong>Class</strong></td>
53 <td class="class-name-in-header">MCollective::Aggregate::Result::Base</td>
55 <tr class="top-aligned-row">
56 <td><strong>In:</strong></td>
58 <a href="../../../../files/lib/mcollective/aggregate/result/base_rb.html">
59 lib/mcollective/aggregate/result/base.rb
65 <tr class="top-aligned-row">
66 <td><strong>Parent:</strong></td>
73 <!-- banner header -->
75 <div id="bodyContent">
79 <div id="contextContent">
85 <div id="method-list">
86 <h3 class="section-bar">Methods</h3>
88 <div class="name-list">
89 <a href="#M000416">new</a>
90 <a href="#M000418">result_type</a>
91 <a href="#M000417">to_s</a>
106 <div id="attribute-list">
107 <h3 class="section-bar">Attributes</h3>
109 <div class="name-list">
111 <tr class="top-aligned-row context-row">
112 <td class="context-item-name">action</td>
113 <td class="context-item-value"> [RW] </td>
114 <td class="context-item-desc"></td>
116 <tr class="top-aligned-row context-row">
117 <td class="context-item-name">aggregate_format</td>
118 <td class="context-item-value"> [RW] </td>
119 <td class="context-item-desc"></td>
121 <tr class="top-aligned-row context-row">
122 <td class="context-item-name">result</td>
123 <td class="context-item-value"> [RW] </td>
124 <td class="context-item-desc"></td>
132 <!-- if method_list -->
134 <h3 class="section-bar">Public Class methods</h3>
136 <div id="method-M000416" class="method-detail">
137 <a name="M000416"></a>
139 <div class="method-heading">
140 <a href="#M000416" class="method-signature">
141 <span class="method-name">new</span><span class="method-args">(result, aggregate_format, action)</span>
145 <div class="method-description">
146 <p><a class="source-toggle" href="#"
147 onclick="toggleCode('M000416-source');return false;">[Source]</a></p>
148 <div class="method-source-code" id="M000416-source">
150 <span class="ruby-comment cmt"># File lib/mcollective/aggregate/result/base.rb, line 7</span>
151 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">result</span>, <span class="ruby-identifier">aggregate_format</span>, <span class="ruby-identifier">action</span>)
152 8: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"No aggregate_format defined in ddl or aggregate function"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">aggregate_format</span>
154 10: <span class="ruby-ivar">@result</span> = <span class="ruby-identifier">result</span>
155 11: <span class="ruby-ivar">@aggregate_format</span> = <span class="ruby-identifier">aggregate_format</span>
156 12: <span class="ruby-ivar">@action</span> = <span class="ruby-identifier">action</span>
157 13: <span class="ruby-keyword kw">end</span>
163 <h3 class="section-bar">Public Instance methods</h3>
165 <div id="method-M000418" class="method-detail">
166 <a name="M000418"></a>
168 <div class="method-heading">
169 <a href="#M000418" class="method-signature">
170 <span class="method-name">result_type</span><span class="method-args">()</span>
174 <div class="method-description">
175 <p><a class="source-toggle" href="#"
176 onclick="toggleCode('M000418-source');return false;">[Source]</a></p>
177 <div class="method-source-code" id="M000418-source">
179 <span class="ruby-comment cmt"># File lib/mcollective/aggregate/result/base.rb, line 19</span>
180 19: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">result_type</span>
181 20: <span class="ruby-ivar">@result</span>[<span class="ruby-identifier">:type</span>]
182 21: <span class="ruby-keyword kw">end</span>
188 <div id="method-M000417" class="method-detail">
189 <a name="M000417"></a>
191 <div class="method-heading">
192 <a href="#M000417" class="method-signature">
193 <span class="method-name">to_s</span><span class="method-args">()</span>
197 <div class="method-description">
198 <p><a class="source-toggle" href="#"
199 onclick="toggleCode('M000417-source');return false;">[Source]</a></p>
200 <div class="method-source-code" id="M000417-source">
202 <span class="ruby-comment cmt"># File lib/mcollective/aggregate/result/base.rb, line 15</span>
203 15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
204 16: <span class="ruby-identifier">raise</span> <span class="ruby-node">"'to_s' method not implemented for result class '#{self.class}'"</span>
205 17: <span class="ruby-keyword kw">end</span>
218 <div id="validator-badges">
219 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>